Skip to main content

Pelican plugin to add footnotes to articles and pages

Project description

Simple Footnotes

Build Status

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.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pelican-simple-footnotes, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size pelican_simple_footnotes-1.0.0-py3-none-any.whl (16.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pelican-simple-footnotes-1.0.0.tar.gz (16.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page