md-to-tui

Crates.iomd-to-tui
lib.rsmd-to-tui
version0.1.2
sourcesrc
created_at2023-06-29 09:38:15.613038
updated_at2023-06-29 12:57:55.911265
descriptionsimple parser from markdown to ratatui types
homepage
repository
max_upload_size
id903099
size30,917
(Horryportier)

documentation

README

md-to-tui

Rust

markdown to ratatui parser

md-to-tui is an markdown parser from md like text to ratatui types

#! its in the early stage and not evrything works for exp. bold/itlic are not working right now becouse of crude and simple implemetion at the time.

Usage

this library implements MarkdownParsable for types that implement ToString trait. You can use parse_markdown fn to parse markdown to Text. parse_markdown takes option of MdStyle and returns Result<Text<'static>, Error>

// example

let md = "
# TODO

- [ ] one
- [ ] two 

[link](http://exp.com)

"
let res = md.parse_markdown(Some(style))

Road map

  • add support for bold and italic
  • make horizontal_rule
  • color number list
  • color headings according to its size
  • maybe add support for codeblock
Commit count: 0

cargo fmt