Simple Pelican plug-in for customising footnotes generated by Docutils.
The plug-in replaces tables generated by Docutils with either bullet list or definition list.
For example a below article:
===============
Example article
===============
:date: 1970-01-01
Lorem ipsum dolor sit amet [#]_, consectetur adipiscing elit. Etiam pulvinar nisl
porta nunc vehicula condimentum. Suspendisse sit amet aliquam felis. Maecenas in
vehicula arcu [#]_. Etiam imperdiet pulvinar est nec gravida. Maecenas commodo
turpis sed tempor pretium [#]_.
.. [#] Lorem ipsum.
.. [#] Lorem ipsum dolor sit amet, consectetur adipiscing elit.
.. [#] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis ac neque
ultricies, mollis metus id, accumsan.
Maecenas sit amet elementum arcu. Aenean vitae erat eget metus porta sodales
malesuada ac diam [#]_. Fusce posuere pulvinar arcu non venenatis. Sed nec lacus a
mauris feugiat tristique [#]_.
.. [#] Lorem ipsum.
.. [#] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis ac neque
ultricies, mollis metus id, accumsan.without the plug-in would be rendered as (borders added to the tables for clarity):
and with the plug-in as:
This plugin can be installed via:
python -m pip install https://github.com/jwierzbi/pelican-rstfootnotes/releases/download/[version]/pelican_rstfootnotes-[version]-py3-none-any.whl
where [version] is the release version of the package you want to install.
All of the requirements should be installed automatically with the plug in but if for some reason this doesn't happen here's command line to install all dependencies:
python -m pip install html5lib
Plugin will replace all footnote tables generated by Docutils with a bullet list by default.
There is a setting that allows changing the bullet list to definition list:
RST_FOOTNOTES_TYPE = 'DEFINITION_LIST'Just put this setting in your pelicanconf.py and you're good to go.
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.
If you're seeing ModuleNotFoundError: No module named 'setuptools' an error
while committing see: pre-commit/pre-commit#2178.
This project is licensed under the AGPL-3.0 license.