#markdown #ratatui #tui #terminal #cli

app markdown-reader

A simple markdown reader that uses ratatui to render markdown files

9 releases

0.1.8 May 23, 2024
0.1.7 Apr 24, 2024
0.1.6 Mar 12, 2024
0.1.4 Feb 27, 2024

#807 in Command-line interface

Download history 520/week @ 2024-02-26 17/week @ 2024-03-04 232/week @ 2024-03-11 3/week @ 2024-03-18 52/week @ 2024-04-01 139/week @ 2024-04-22 2/week @ 2024-04-29 159/week @ 2024-05-20

167 downloads per month

MIT/Apache

36KB
673 lines

Markdown Reader

Crate badge Deps.rs Badge License Badge Codecov.io Badge Discord Badge

GitHub Repository · Changelog · Contributing

An experimental Proof of Concept markdown reader that uses Ratatui to render markdown files. The primary purpose of this crate is to test the tui-markdown crate. It is not ready for any sort of real world use.

Made with VHS

Installation

To install the markdown reader application (mdr):

cargo install --locked markdown-reader

Usage

mdr --help

A simple markdown reader that uses ratatui to render markdown files.

Usage: mdr [PATH]

Arguments:
  [PATH]  The path to the markdown file to read [default: README.md]

Options:
  -h, --help     Print help
  -V, --version  Print version

Status

Initial implementation - this is very much WIP (see lib.rs todo!()s)

  • Headings
  • Heading attributes / classes / anchors
  • Normal paragraphs
  • Block quotes
  • Nested block quotes
  • Bold (strong)
  • Italic (emphasis)
  • Strikethrough
  • Ordered lists
  • Unordered lists
  • Code blocks
  • Html
  • Footnotes
  • Tables
  • Linebreak handling
  • Rule
  • Tasklists
  • Links
  • Images
  • Metadata blocks

License

Copyright (c) 2024 Josh McKinney

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See CONTRIBUTING.md.

Dependencies

~17–25MB
~337K SLoC