Struct markdown_it::MarkdownIt

pub struct MarkdownIt {
    pub block: BlockParser,
    pub inline: InlineParser,
    pub link_formatter: Box<dyn LinkFormatter>,
    pub ext: MarkdownItExtSet,
    pub max_indent: i32,
    /* private fields */
}

Main parser struct, created once and reused for parsing multiple documents.

Fields

block: BlockParser

Block-level tokenizer.

inline: InlineParser

Inline-level tokenizer.

link_formatter: Box<dyn LinkFormatter>

Link validator and formatter.

ext: MarkdownItExtSet

Storage for custom data used in plugins.

max_indent: i32

Maximum allowed indentation for syntax blocks default i32::MAX, indented code blocks will set this to 4

Implementations

impl MarkdownIt

pub fn new() -> Self

Examples found in repository

examples/ferris/main.rs (line 8)

fn main() {
    // create markdown parser
    let md = &mut markdown_it::MarkdownIt::new();

    // add commonmark syntax, you almost always want to do that
    markdown_it::plugins::cmark::add(md);

    // add custom three rules described above
    inline_rule::add(md);
    block_rule::add(md);
    core_rule::add(md);

    // and now you can use it
    let html = md.parse(r#"
(\/) hello world (\/)
(\/)-------------(\/)
    "#).render();

    print!("{html}");

    assert_eq!(html.trim(), r#"
<p><span class="ferris-inline">🦀</span> hello world <span class="ferris-inline">🦀</span></p>
<div class="ferris-block"><img src="https://upload.wikimedia.org/wikipedia/commons/0/0f/Original_Ferris.svg"></div>
<footer class="ferris-counter">There are 3 crabs lurking in this document.</footer>
    "#.trim());
}

pub fn parse(&self, src: &str) -> Node

Examples found in repository

examples/ferris/main.rs (lines 19-22)

fn main() {
    // create markdown parser
    let md = &mut markdown_it::MarkdownIt::new();

    // add commonmark syntax, you almost always want to do that
    markdown_it::plugins::cmark::add(md);

    // add custom three rules described above
    inline_rule::add(md);
    block_rule::add(md);
    core_rule::add(md);

    // and now you can use it
    let html = md.parse(r#"
(\/) hello world (\/)
(\/)-------------(\/)
    "#).render();

    print!("{html}");

    assert_eq!(html.trim(), r#"
<p><span class="ferris-inline">🦀</span> hello world <span class="ferris-inline">🦀</span></p>
<div class="ferris-block"><img src="https://upload.wikimedia.org/wikipedia/commons/0/0f/Original_Ferris.svg"></div>
<footer class="ferris-counter">There are 3 crabs lurking in this document.</footer>
    "#.trim());
}

pub fn add_rule<T: CoreRule>( &mut self ) -> RuleBuilder<'_, fn(_: &mut Node, _: &MarkdownIt)>

Examples found in repository

examples/ferris/core_rule.rs (line 63)

pub fn add(md: &mut MarkdownIt) {
    // insert this rule into parser
    md.add_rule::<FerrisCounterRule>();
}

pub fn has_rule<T: CoreRule>(&mut self) -> bool

pub fn remove_rule<T: CoreRule>(&mut self)

Trait Implementations

impl Debug for MarkdownIt

fn fmt(&self, __f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MarkdownIt

fn default() -> Self

Returns the “default value” for a type.