https://github.com/pelican-plugins/simple-footnotes

Adds footnotes to articles and pages
https://github.com/pelican-plugins/simple-footnotes

Last synced: 3 months ago
JSON representation

Adds footnotes to articles and pages

• Host: GitHub
• URL: https://github.com/pelican-plugins/simple-footnotes
• Owner: pelican-plugins
• License: agpl-3.0
• Created: 2019-10-17T18:32:39.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-02T08:43:10.000Z (7 months ago)
• Last Synced: 2024-09-15T07:48:26.989Z (5 months ago)
• Language: Python
• Homepage:
• Size: 74.2 KB
• Stars: 8
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-pelican - simple-footnotes - simple-footnotes)](https://pypi.org/project/pelican-simple-footnotes/) | [pelican-plugins](https://github.com/pelican-plugins) | Adds footnotes to articles and pages (Plugins / Migrated to new architecture)

README

        
Simple Footnotes

================

[![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/simple-footnotes/main.yml?branch=main)](https://github.com/pelican-plugins/simple-footnotes/actions)

[![PyPI Version](https://img.shields.io/pypi/v/pelican-simple-footnotes)](https://pypi.org/project/pelican-simple-footnotes/)

[![Downloads](https://img.shields.io/pypi/dm/pelican-simple-footnotes)](https://pypi.org/project/pelican-simple-footnotes/)

![License](https://img.shields.io/pypi/l/pelican-simple-footnotes?color=blue)

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](https://docs.getpelican.com/en/latest/plugins.html#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](https://kryogenix.org/), February 2014, and subsequently enhanced by members of the Pelican community, including [Justin Mayer](https://justinmayer.com/), who re-packaged it for publication to PyPI.

Inspired by Andrew Nacin’s [Simple Footnotes WordPress plugin](https://wordpress.org/plugins/simple-footnotes/).

[existing issues]: https://github.com/pelican-plugins/simple-footnotes/issues

[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html