minimad 0.6.2

light Markdown parser
Documentation

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.5"
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(),
    ])
);