mdformat-crystal

Mdformat plugin to format crystal code blocks

Description

mdformat-crystal is an mdformat plugin that makes mdformat format crystal code blocks embedded in Markdown with crystal tool format. The plugin invokes crystal in a subprocess so having either crystal, Docker or Podman installed is a requirement.

Installing

1. Install either crystal, Docker or Podman
2. Install mdformat-crystal

   pip install mdformat-crystal

Usage

mdformat YOUR_MARKDOWN_FILE.md

Limitations

The Docker/Podman fallback is only tested on Linux. If you experience issues with it on Windows or macOS, please install crystal.