rustdown-cli 0.1.2

Render markdown/html/html-markdown in the terminal
Documentation 
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

# rustdown — terminal Markdown renderer

A minimal, colorized Markdown renderer for the terminal using [pulldown-cmark](https://github.com/pulldown-cmark/pulldown-cmark), [termcolor](https://crates.io/crates/termcolor) and [clap](https://docs.rs/clap/latest/clap/).

## Demo
[Demo](https://github.com/user-attachments/assets/dc35588b-6040-4c76-89b6-86521f867754)

## Installation
`cargo install rustdown-cli`

## Quick start

- Build: cargo build
- Run (renders embedded reference): cargo run
- Render a file: cargo run -- PATH/TO/FILE.md

# Usage examples

- Render the built-in reference:

  cargo run

- Render a specific file:

  cargo run -- references/full.md

- Page colored output through less (preserve colors):

  cargo run -- references/full.md | less -R

- Run in release mode for faster startup:

  cargo run --release -- docs/long.md

## Features

- Headers (H1..H6) with color and ASCII underlines
- Emphasis, bold, strikethrough
- Ordered + unordered lists with nesting
- Task lists (checked/unchecked)
- Links and images (displayed as text with URL)
- Code blocks and inline code
- Blockquotes, horizontal rules, footnotes