tui-markdown
| Crates.io | tui-markdown |
| lib.rs | tui-markdown |
| version | 0.2.12 |
| source | src |
| created_at | 2024-02-27 09:57:18.66201 |
| updated_at | 2024-10-22 07:30:26.981688 |
| description | A simple library for converting markdown to a Rataui Text value |
| homepage | |
| repository | https://github.com/joshka/tui-markdown |
| max_upload_size | |
| id | 1154968 |
| size | 72,870 |
Josh McKinney (joshka)
documentation
https://docs.rs/tui-markdown
README
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.
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
- 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.