unified

Project: micromark/micromark-extension-footnote

Package: micromark-extension-footnote@0.3.2

  1. Dependencies: 1·Dependents: 2
  2. micromark extension to support footnotes
  1. unified 169
  2. markdown 142
  3. micromark 16
  4. micromark-extension 16
  5. definition 14
  6. footnote 3
  7. note 3

micromark-extension-footnote

Build Coverage Downloads Size Sponsors Backers Chat

micromark extension to support footnotes.

As there is no spec for footnotes in markdown, this extension stays as close to references and list items in CommonMark, while being inspired by the HTML output of Pandoc notes.

This package provides the low-level modules for integrating with the micromark tokenizer and the micromark HTML compiler.

You probably shouldn’t use this package directly, but instead use mdast-util-footnote with mdast or remark-footnotes with remark.

Install

npm:

npm install micromark-extension-footnote

Use

Say we have the following file, example.md:

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

[^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.

        { some.code }

    The whole paragraph can be indented, or just the first
    line.  In this way, multi-paragraph footnotes work like
    multi-paragraph list items.

This paragraph won’t be part of the note, because it
isn’t indented.

Here is an inline note.^[Inlines notes are easier to write, since
you don’t have to pick an identifier and move down to type the
note.]

And our script, example.js, looks as follows:

var fs = require('fs')
var micromark = require('micromark')
var footnote = require('micromark-extension-footnote')
var footnoteHtml = require('micromark-extension-footnote/html')

var doc = fs.readFileSync('example.md')

var result = micromark(doc, {
  extensions: [footnote({inlineNotes: true})],
  htmlExtensions: [footnoteHtml]
})

console.log(result)

Now, running node example yields:

<p>Here is a footnote call,<a href="#fn1" class="footnote-ref" id="fnref1"><sup>1</sup></a> and another.<a href="#fn2" class="footnote-ref" id="fnref2"><sup>2</sup></a></p>
<p>This paragraph won’t be part of the note, because it
isn’t indented.</p>
<p>Here is an inline note.<a href="#fn1" class="footnote-ref" id="fnref1"><sup>1</sup></a></p>
<div class="footnotes">
<hr />
<ol>
<li id="fn1">
<p>Here is the footnote.<a href="#fnref1" class="footnote-back">↩︎</a></p>
</li>
<li id="fn2">
<p>Here’s one with multiple blocks.</p>
<p>Subsequent paragraphs are indented to show that they
belong to the previous footnote.</p>
<pre><code>{ some.code }
</code></pre>
<p>The whole paragraph can be indented, or just the first
line.  In this way, multi-paragraph footnotes work like
multi-paragraph list items.<a href="#fnref2" class="footnote-back">↩︎</a></p>
</li>
<li id="fn3">
<p>Inlines notes are easier to write, since
you don’t have to pick an identifier and move down to type the
note.<a href="#fnref3" class="footnote-back">↩︎</a></p>
</li>
</ol>
</div>

API

html

syntax(options?)

Note: syntax is the default export of this module, html is available at micromark-extension-footnote/html.

Support footnotes. The export of syntax is a function that can be called with options and returns an extension for the micromark parser (to tokenize footnotes; can be passed in extensions). The export of html is an extension for the default HTML compiler (to compile as HTML; can be passed in htmlExtensions).

options.inlineNotes

Whether to support ^[inline notes] (boolean, default: false).

Contribute

See contributing.md in micromark/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer