markdown-it-footnote-here v1.0.3

markdown-it-footnote-here

Footnotes plugin for markdown-it markdown parser.

v2.+ requires markdown-it v5.+, see changelog.

Markup is based on pandoc definition.

Normal footnote:

Here is a footnote reference,[^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.

html:

<p>Here is a footnote reference,<sup class="footnote-ref"><a href="#fn1" id="fnref1">[1]</a></sup> and another.<sup class="footnote-ref"><a href="#fn2" id="fnref2">[2]</a></sup></p>
<section class="footnotes">
<ol class="footnotes-list">
<li value="1" id="fn1" class="footnote-item"><p>Here is the footnote.</p>
</li>
<li value="2" id="fn2" class="footnote-item"><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.</p>
</li>
</ol>
</section>
<p>This paragraph won't be part of the note, because it
isn't indented.</p>

Each footnote keep their positions:

Here is footnote-here reference.[^1].

[^1]: Here is the footnote.

Next footnote is here.[^2]

[^2]: Here is next footnote.

<p>Here is footnote-here reference.<sup class="footnote-ref"><a href="#fn1" id="fnref1">[1]</a></sup>.</p>
<section class="footnotes">
<ol class="footnotes-list">
<li value="1" id="fn1" class="footnote-item"><p>Here is the footnote.</p>
</li>
</ol>
</section>
<p>Next footnote is here.<sup class="footnote-ref"><a href="#fn2" id="fnref2">[2]</a></sup></p>
<section class="footnotes">
<ol class="footnotes-list">
<li value="2" id="fn2" class="footnote-item"><p>Here is next footnote.</p>
</li>
</ol>
</section>

Install

node.js, browser:

npm install markdown-it-footnote-here --save
bower install markdown-it-footnote-here --save

Use

var md = require('markdown-it')()
            .use(require('markdown-it-footnote-here'));

md.render(/*...*/) // See examples above

Differences in browser. If you load script directly into the page, without package system, module will add itself globally as window.markdownitFootnote.

Customize

If you want to customize the output, you'll need to replace the template functions. To see which templates exist and their default implementations, look in index.js. The API of these template functions is out of scope for this plugin's documentation; you can read more about it in the markdown-it documentation.

License

MIT