#markdown-text #markdown #tui #ratatui #terminal #cli

tui-markdown

A simple library for converting markdown to a Rataui Text value

16 releases

new 0.3.0 Nov 20, 2024
0.2.10 Sep 20, 2024
0.2.6 Jun 24, 2024
0.2.2 Mar 2, 2024

#760 in Command-line interface

Download history 140/week @ 2024-08-05 4/week @ 2024-08-12 153/week @ 2024-09-02 364/week @ 2024-09-16 23/week @ 2024-09-23 95/week @ 2024-09-30 7/week @ 2024-10-07 182/week @ 2024-10-14 213/week @ 2024-10-21 484/week @ 2024-10-28 362/week @ 2024-11-04 102/week @ 2024-11-11

1,166 downloads per month
Used in markdown-reader

MIT/Apache

31KB
637 lines

Tui-markdown

An experimental Proof of Concept library for converting markdown content to a Ratatui Text value. See Markdown-reader for an example application that uses this library.

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

GitHub Repository · API Docs · [Examples] · Changelog · Contributing

Installation

cargo add tui-markdown

Usage

let input = "# Heading\n\n**bold**"; // this can come from whereever
let text = tui_markdown::from_str(input);
text.render(area, &mut buf);

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

~9–18MB
~240K SLoC