36 releases

0.13.1 May 22, 2024
0.13.0 Aug 13, 2023
0.12.0 Mar 9, 2023
0.9.1 Sep 20, 2022
0.4.1 Jul 2, 2019

#139 in Parser implementations

Download history 10415/week @ 2024-02-15 10990/week @ 2024-02-22 12078/week @ 2024-02-29 12503/week @ 2024-03-07 13384/week @ 2024-03-14 13933/week @ 2024-03-21 11505/week @ 2024-03-28 12003/week @ 2024-04-04 12914/week @ 2024-04-11 12804/week @ 2024-04-18 11051/week @ 2024-04-25 11456/week @ 2024-05-02 11060/week @ 2024-05-09 11355/week @ 2024-05-16 9659/week @ 2024-05-23 10416/week @ 2024-05-30

45,167 downloads per month
Used in 85 crates (4 directly)

MIT license

97KB
2.5K SLoC

MIT Latest Version docs Chat on Miaou

A simple, non universal purpose, markdown parser.

If you're looking for a Markdown parser, this one is probably not the one you want:

Minimad can be used on its own but is first designed for the termimad lib, which displays static and dynamic markdown snippets on a terminal without mixing the skin with the code. Minimad sports a line-oriented flat structure (i.e. not a tree) which might not suit your needs.

If you still think you might use Minimad directly (not through Temimad), you may contact me on Miaou for advice.

Usage

[dependencies]
minimad = "0.7"
assert_eq!(
    Line::from("## a header with some **bold**!"),
    Line::new_header(
        2,
        vec![
            Compound::raw_str("a header with some "),
            Compound::raw_str("bold").bold(),
            Compound::raw_str("!"),
        ]
    )
);

assert_eq!(
    Line::from("Hello ~~wolrd~~ **World**. *Code*: `sqrt(π/2)`"),
    Line::new_paragraph(vec![
        Compound::raw_str("Hello "),
        Compound::raw_str("wolrd").strikeout(),
        Compound::raw_str(" "),
        Compound::raw_str("World").bold(),
        Compound::raw_str(". "),
        Compound::raw_str("Code").italic(),
        Compound::raw_str(": "),
        Compound::raw_str("sqrt(π/2)").code(),
    ])
);

Dependencies

~48KB