Skip to content

spinualexandru/rustdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rustdown — terminal Markdown renderer

A minimal, colorized Markdown renderer for the terminal using pulldown-cmark, termcolor and clap.

Demo

1.webm

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

Requirements

  • Rust 1.56+ (edition 2021)

License

WTFPL

About

Terminal renderer for Markdown

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages