README.md

Markdown Reader

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.

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

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

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.