pelican-simple-footnotes 1.0.3

Pelican plugin to add footnotes to articles and pages

Simple Footnotes

Simple Footnotes is a Pelican plugin for adding footnotes to articles and pages.

Installation

This plugin, and its dependent package html5lib, can be installed via:

python -m pip install pelican-simple-footnotes

As long as you have not explicitly added a PLUGINS setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add simple_footnotes to your existing PLUGINS list. For more information, please see the How to Use Plugins documentation.

Usage

When writing an article or page, add a footnote like this:

Here’s my written text[ref]and here is a footnote[/ref].

This will appear as, roughly:

Here is my written text¹

1. and here is a footnote ↩︎

This should work with any content format (Markdown, reStructuredText, et cetera), because the plugin looks for [ref] and [/ref] once the conversion to HTML has happened.

Contributing

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.

To start contributing to this plugin, review the Contributing to Pelican documentation, beginning with the Contributing Code section.

Credits

Originally authored by Stuart Langridge, February 2014, and subsequently enhanced by members of the Pelican community, including Justin Mayer, who re-packaged it for publication to PyPI.

Inspired by Andrew Nacin’s Simple Footnotes WordPress plugin.