Simple Footnotes
================
[](https://github.com/pelican-plugins/simple-footnotes/actions)
[](https://pypi.org/project/pelican-simple-footnotes/)
[](https://pypi.org/project/pelican-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](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 text<sup>1</sup>
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
Raw data
{
"_id": null,
"home_page": null,
"name": "pelican-simple-footnotes",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": "pelican, plugin, footnotes",
"author": null,
"author_email": "Stuart Langridge <sil@kryogenix.org>, Justin Mayer <entroP@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b5/5c/0343d4e0c9668c05c9b142e3f82f4e2b4b696c5b67668670cbef6b94b5e7/pelican_simple_footnotes-1.0.3.tar.gz",
"platform": null,
"description": "Simple Footnotes\n================\n\n[](https://github.com/pelican-plugins/simple-footnotes/actions)\n[](https://pypi.org/project/pelican-simple-footnotes/)\n[](https://pypi.org/project/pelican-simple-footnotes/)\n\n\nSimple Footnotes is a Pelican plugin for adding footnotes to articles and pages.\n\nInstallation\n------------\n\nThis plugin, and its dependent package `html5lib`, can be installed via:\n\n python -m pip install pelican-simple-footnotes\n\nAs 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.\n\nUsage\n-----\n\nWhen writing an article or page, add a footnote like this:\n\n Here\u2019s my written text[ref]and here is a footnote[/ref].\n\nThis will appear as, roughly:\n\nHere is my written text<sup>1</sup>\n\n 1. and here is a footnote \u21a9︎\n\nThis 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.\n\nContributing\n------------\n\nContributions 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][].\n\nTo start contributing to this plugin, review the [Contributing to Pelican][] documentation, beginning with the **Contributing Code** section.\n\nCredits\n-------\n\nOriginally 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.\n\nInspired by Andrew Nacin\u2019s [Simple Footnotes WordPress plugin](https://wordpress.org/plugins/simple-footnotes/).\n\n\n[existing issues]: https://github.com/pelican-plugins/simple-footnotes/issues\n[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Pelican plugin to add footnotes to articles and pages",
"version": "1.0.3",
"project_urls": {
"Funding": "https://donate.getpelican.com/",
"Homepage": "https://github.com/pelican-plugins/simple-footnotes",
"Issue tracker": "https://github.com/pelican-plugins/simple-footnotes/issues"
},
"split_keywords": [
"pelican",
" plugin",
" footnotes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d8184aa1405b22b651f7a2c7a62aa16ecf07ab321c82bc08e48b3af2a34ef68",
"md5": "3bb5fc58793f6dd496b1f1ecd91431eb",
"sha256": "eefd69e577cb22709b661ec302b2e39ec9dce7bf002a6c260c735c030ba44e20"
},
"downloads": -1,
"filename": "pelican_simple_footnotes-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3bb5fc58793f6dd496b1f1ecd91431eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 16917,
"upload_time": "2024-06-14T07:39:32",
"upload_time_iso_8601": "2024-06-14T07:39:32.659829Z",
"url": "https://files.pythonhosted.org/packages/8d/81/84aa1405b22b651f7a2c7a62aa16ecf07ab321c82bc08e48b3af2a34ef68/pelican_simple_footnotes-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b55c0343d4e0c9668c05c9b142e3f82f4e2b4b696c5b67668670cbef6b94b5e7",
"md5": "6be980d14dcf215eb88fdb17fb8ba766",
"sha256": "0cdf6bf3c35118565a9c063238da4dcaf819aa9aceac4a53d0fd04cd2b363271"
},
"downloads": -1,
"filename": "pelican_simple_footnotes-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "6be980d14dcf215eb88fdb17fb8ba766",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 16752,
"upload_time": "2024-06-14T07:39:34",
"upload_time_iso_8601": "2024-06-14T07:39:34.012019Z",
"url": "https://files.pythonhosted.org/packages/b5/5c/0343d4e0c9668c05c9b142e3f82f4e2b4b696c5b67668670cbef6b94b5e7/pelican_simple_footnotes-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-14 07:39:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pelican-plugins",
"github_project": "simple-footnotes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pelican-simple-footnotes"
}
JSON
