A command-line tool for formatting markdown text with consistent empty lines and spacing.
- Add spaces between CJK and Latin/ASCII characters
- Add blank lines after header/table/code block
- Add blank lines before table/code block
- Remove extra blank lines
- Align table columns
- Format ordered and unordered lists
- Ensure Rust 1.85+ is installed
- Build release binary:
cd mdformat
cargo build --release- The binary will be in
target/release/mdformat
Basic formatting:
mdformat input.md -o formatted.mdPipe from stdin/stdout:
cat input.md | mdformat > formatted.mdFormats Markdown code with consistent empty lines and spacing
Usage: mdformat [OPTIONS] [INPUT]
Arguments:
[INPUT] Input file (default: stdin)
Options:
-o, --output <OUTPUT> Output file (default: stdout)
-i, --indent <INDENT> Number of spaces for indentation [default: 4]
-h, --help Print help
-V, --version Print version
MIT Licensed