Snapshot of markdown-it/markdown-it-footnote: 247★, JavaScript. Footnotes plugin for markdown-it markdown parser
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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>
<p>This paragraph won’t be part of the note, because it
isn’t indented.</p>
<hr class="footnotes-sep">
<section class="footnotes">
<ol class="footnotes-list">
<li id="fn1" class="footnote-item"><p>Here is the footnote. <a href="#fnref1" class="footnote-backref">↩</a></p>
</li>
<li 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. <a href="#fnref2" class="footnote-backref">↩</a></p>
</li>
</ol>
</section>
Inline footnote:
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.]
html:
<p>Here is an inline note.<sup class="footnote-ref"><a href="#fn1" id="fnref1">[1]</a></sup></p>
<hr class="footnotes-sep">
<section class="footnotes">
<ol class="footnotes-list">
<li id="fn1" class="footnote-item"><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="#fnref1" class="footnote-backref">↩</a></p>
</li>
</ol>
</section>
var md = require('markdown-it')()
.use(require('markdown-it-footnote'));
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.mjs. 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.
To demonstrate with an example, here is how you might replace the <hr> that
this plugin emits by default with an <h4> emitted by your own template
function override:
Yes — markdown-it/markdown-it-footnote ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/markdown-it/markdown-it-footnote.
What is markdown-it/markdown-it-footnote?
markdown-it/markdown-it-footnote (markdown-it/markdown-it-footnote) is a JavaScript project on GitHub. From the project's own README: Footnotes plugin for markdown-it markdown parser
Where do I read more about markdown-it/markdown-it-footnote?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/markdown-it/markdown-it-footnote is the definitive source.
Read full README in the tab above.
Curious whether markdown-it-footnote is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about markdown-it-footnote.
/markdown-it-footnote
