mad 0.1.1

A fast Markdown terminal renderer with syntax highlighting
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

# mad

[![Crates.io](https://img.shields.io/crates/v/mad.svg)](https://crates.io/crates/mad)
[![docs.rs](https://docs.rs/mad/badge.svg)](https://docs.rs/mad)
[![CI](https://github.com/macalinao/mad/actions/workflows/ci.yml/badge.svg)](https://github.com/macalinao/mad/actions/workflows/ci.yml)
[![License](https://img.shields.io/crates/l/mad.svg)](https://github.com/macalinao/mad/blob/master/LICENSE)

A fast Markdown terminal renderer with syntax highlighting

Renders Markdown files as beautifully formatted ANSI terminal output with syntax-highlighted code blocks, clickable hyperlinks, tables, and intelligent text wrapping.

## Installation

### Cargo

```bash
cargo install mad
```

### Nix

```bash
nix run github:macalinao/mad -- README.md
nix profile install github:macalinao/mad
```

## Usage

```bash
# Render a Markdown file
mad README.md

# Pipe from stdin
cat README.md | mad

# Disable syntax highlighting
mad --no-highlight README.md

# Set a custom width
mad --width 100 README.md
```

### Options

| Flag | Short | Description |
| --- | --- | --- |
| \`--no-highlight\` | \`-n\` | Disable syntax highlighting for code blocks |
| \`--width <COLS>\` | \`-w\` | Wrap text to specified width (defaults to terminal width) |
| \`--version\` | | Print version |
| \`--help\` | \`-h\` | Print help |

## License

Apache-2.0