mdformat 0.1.6

A formatter for markdown source code.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# Markdown Formatter

A command-line tool for formatting markdown text with consistent empty lines and spacing.

## Features

- 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

## Installation

### From Source

1. Ensure Rust 1.85+ is installed
2. Build release binary:

```bash
cd mdformat
cargo build --release
```

3. The binary will be in `target/release/mdformat`

## Usage

Basic formatting:

```bash
mdformat input.md -o formatted.md
```

Pipe from stdin/stdout:

```bash
cat input.md | mdformat > formatted.md
```

## Command Line Options

```
Formats 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
```

## License

MIT Licensed