pelican-simple-footnotes

Pelican plugin to add footnotes to articles and pages


Keywords
footnotes, pelican, plugin
License
AGPL-3.0
Install
pip install pelican-simple-footnotes==1.0.2

Documentation

Simple Footnotes

Build Status PyPI Version

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

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’s my written text1

  1. and here is a footnote ↩

This should work with any content format (reST, Markdown, et cetera), because it 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.