Tobias Bölz
b3a482ec34
All checks were successful
Update Docs / docs (push) Successful in 37s
Reviewed-on: #13 Co-authored-by: Tobias Bölz <tobias@boelz.eu> Co-committed-by: Tobias Bölz <tobias@boelz.eu> |
||
|---|---|---|
| .forgejo/workflows | ||
| docs | ||
| pelican/plugins/feed_content_footer | ||
| .gitignore | ||
| CHANGELOG.md | ||
| LICENSE | ||
| mkdocs.yml | ||
| noxfile.py | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
Feed Content Footer: A Plugin for Pelican
Pelican plugin that adds a footer to RSS/Atom feed items content.
Website: https://tmb.codeberg.page/pelican-feed-content-footer/
Repository: https://git.boelz.eu/tmb/pelican-feed-content-footer/
Codeberg mirror: https://codeberg.org/tmb/pelican-feed-content-footer/
Installation
This plugin can be installed via:
$ python -m pip install pelican-feed-content-footer
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 feed_content_footer to your existing PLUGINS list. For more information, please see the How to Use Plugins documentation.
Usage
Add the following to your settings file:
FEED_CONTENT_FOOTER
A string that will be appended to the content of every entry in your Atom feed and, if RSS_FEED_SUMMARY_ONLY is False, to the description of every item in your RSS feed inside a HTML footer tag.
Development
This package uses Poetry.
Run tests with all supported versions of Python and Pelican:
$ poetry run nox -rs test
Run linters:
$ poetry run nox -s lint
Run code coverage check:
$ poetry run nox -s coverage
License
This project is licensed under the AGPL-3.0 license.