Nefariously Programmed Mecha
    Wondering what’s next for npm?Check out our public roadmap! »

    markdown-it-footnote-conventional

    2.0.1 • Public • Published

    markdown-it-footnote-conventional

    This is a fork of markdown-it-footnote, for which:

    • <div class="footnotes"> is used in lieu of <section class="footnotes">
    • <hr class="footnotes-sep"> is placed after the opening <div class="footnotes"> instead of before
      • This makes Bigfoot.js's removal of the "footnotes <div>" work properly

    Both changes are more conventional, at least as far as I can see ;)


    Build Status NPM version Coverage Status

    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>
    <p>This paragraph won’t be part of the note, because it
    isn’t indented.</p>
    <div class="footnotes">
    <hr class="footnotes-sep">
    <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>
    </div>

    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>
    <div class="footnotes">
    <hr class="footnotes-sep">
    <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>
    </div>

    Install

    node.js, browser:

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

    Use

    var md = require('markdown-it')()
                .use(require('markdown-it-footnote-conventional'));
     
    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.

    License

    MIT

    Install

    npm i markdown-it-footnote-conventional

    DownloadsWeekly Downloads

    0

    Version

    2.0.1

    License

    MIT

    Last publish

    Collaborators

    • avatar