This package has been deprecated

Author message:

end of development

magu-plugin-footnote

0.0.1 • Public • Published

magu-plugin-footnote

Magu plugin that create footnotes.

Build Status XO code style

Install

yarn add magu-plugin-footnote
npm install magu-plugin-footnote

Usage

magu({}, [footnote({
  // Below is the default value
  selector: 'a[href^="*"]',
  footnoteTemplate: `
<span class=footernote__text>{text}</span>
<small class=footernote__link-small>
  ※<a id={id} class=footnote__link href=#{href}>{idx}</a>
</small>
  `.trim(),
  footerFootnoteListTemplate: '<ol class="footer-footnote__list"></ol>',
  footerFootnoteItemTemplate: `
<li class=footer-footnote__item>
  <span class=footer-footnote__text>{footerText}</span>
  <a id={href} href=#{id} class=footer-footnote__link>⇧</a>
</li>
  `.trim()
})])
  .process(`${__dirname}/example.md`)
  .then(result => console.log(result.html));

Options

  • selector(default: a[href^="*"])
    Specify selector for footnote
  • footnoteTemplate
    Specify the footnote template in the original position
  • footerFootnoteListTemplate
    Specify template to put footnote list in footer
  • footerFootnoteItemTemplate
    Specify footnote template in footer

The above template is given the same options like {idx, id, href, text, footerText}

Please think that it is being processed using sindresorhus/pupa as follows

pupa(***Template, opts);

Example

If the ${__dirname}/example.md of the Usage section is as follows

foooooooooo[abcde](*aiueo)foooooooo

barrrrrrrrr[かきく](*kakiku)barrrrrr

result like this

<p>foooooooooo<span class="footernote__text">aiueo</span>
  <small class="footernote__link-small"><a id="aiueo" class="footnote__link" href="#footer-aiueo">1</a>
</small>foooooooo</p>
<p>barrrrrrrrr<span class="footernote__text">kakiku</span>
  <small class="footernote__link-small"><a id="kakiku" class="footnote__link" href="#footer-kakiku">2</a>
</small>barrrrrr</p>
<ol class="footer-footnote__list">
  <li class="footer-footnote__item">
    <span class="footer-footnote__text">abcde</span>
    <a id="footer-aiueo" href="#aiueo" class="footer-footnote__link"></a>
  </li>
  <li class="footer-footnote__item">
    <span class="footer-footnote__text">かきく</span>
    <a id="footer-kakiku" href="#kakiku" class="footer-footnote__link"></a>
  </li>
</ol>

License

The MIT License (MIT) Copyright (c) 2016 nju33 nju33.ki@gmail.com

Package Sidebar

Install

npm i magu-plugin-footnote

Weekly Downloads

1

Version

0.0.1

License

MIT

Last publish

Collaborators

  • nju33