3 unstable releases

0.2.0 Aug 3, 2023
0.1.1 Jun 21, 2023
0.1.0 Jun 17, 2023

#2734 in Parser implementations

Download history 36/week @ 2024-03-11 21/week @ 2024-03-18 24/week @ 2024-03-25 92/week @ 2024-04-01 21/week @ 2024-04-08 25/week @ 2024-04-15 24/week @ 2024-04-22 13/week @ 2024-04-29 25/week @ 2024-05-06 19/week @ 2024-05-13 15/week @ 2024-05-20 31/week @ 2024-05-27 24/week @ 2024-06-03 22/week @ 2024-06-10 38/week @ 2024-06-17 22/week @ 2024-06-24

109 downloads per month
Used in vitrine

Apache-2.0

30KB
468 lines

markdown-it-footnote.rs

crates.io

A markdown-it.rs plugin to process footnotes.

It is based on the pandoc definition:

Normal footnote:

Here is a footnote reference,[^1] and another.[^longnote]

Here is an inline note.^[my note is here!]

[^1]: Here is the footnote.

[^longnote]: Here's one with multiple blocks.

    Subsequent paragraphs are indented to show that they
belong to the previous footnote.

See the tests for more examples.

Usage

To load the full plugin:

let parser = &mut markdown_it::MarkdownIt::new();
markdown_it::plugins::cmark::add(parser);

markdown_it_footnote::add(parser);

let ast  = parser.parse("Example^[my note]");
let html = ast.render();

Alternatively, you can load the separate components:

let parser = &mut markdown_it::MarkdownIt::new();
markdown_it::plugins::cmark::add(parser);

markdown_it_footnote::definitions::add(md);
markdown_it_footnote::references::add(md);
markdown_it_footnote::inline::add(md);
markdown_it_footnote::collect::add(md);
markdown_it_footnote::back_refs::add(md);

Which have the following roles:

  • definitions: parse footnote definitions, e.g. [^1]: foo
  • references: parse footnote references, e.g. [^1]
  • inline: parse inline footnotes, e.g. ^[foo]
  • collect: collect footnote definitions (removing duplicate/unreferenced ones) and move them to be the last child of the root node.
  • back_refs: add anchor(s) to footnote definitions, with links back to the reference(s)

Dependencies

~5–7MB
~159K SLoC