Skip to main content

Simple Footnotes

Build Status PyPI Version Downloads License

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 text1

  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.

Metadata

Release files for pelican-simple-footnotes 1.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pelican-simple-footnotes 1.0.3
File Size Uploaded
pelican_simple_footnotes-1.0.3.tar.gz 16.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pelican-simple-footnotes 1.0.3
File Interpreter ABI Platform
pelican_simple_footnotes-1.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 33.7 kB

Release files / pelican_simple_footnotes-1.0.3.tar.gz

Download URL pelican_simple_footnotes-1.0.3.tar.gz
Size 16.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0cdf6bf3c35118565a9c063238da4dcaf819aa9aceac4a53d0fd04cd2b363271
BLAKE2b-256 checksum
How to use checksums
b55c0343d4e0c9668c05c9b142e3f82f4e2b4b696c5b67668670cbef6b94b5e7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.4

Release files / pelican_simple_footnotes-1.0.3-py3-none-any.whl

Download URL pelican_simple_footnotes-1.0.3-py3-none-any.whl
Size 16.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
eefd69e577cb22709b661ec302b2e39ec9dce7bf002a6c260c735c030ba44e20
BLAKE2b-256 checksum
How to use checksums
8d8184aa1405b22b651f7a2c7a62aa16ecf07ab321c82bc08e48b3af2a34ef68
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.4

Release history Release notifications | RSS feed

This release

1.0.3 This release

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page