A plugin for MkDocs, the static site generator, which creates RSS 2.0 feeds using the creation and modification dates from git log.
Typical mkdocs.yml
:
plugins:
- rss:
abstract_chars_count: 160
date_from_meta:
as_creation: "date"
as_update: false
datetime_format: "%Y-%m-%d %H:%M"
feed_ttl: 1440
image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png
length: 20
pretty_print: false
For further information, see the user documentation.
For further information, see the technical documentation.
Installation:
pip install mkdocs-rss-plugin
Then in your mkdocs.yml
:
plugins:
- rss
As examples, here come the feeds generated for this documentation:
Or it could be displayed as a Feedly follow button:
Plugin logic is inspired from Tim Vink git-based plugins and main parts of Git stuff are nearly copied/pasted.
Using magic from:
Documentation theme United from mkdocs-bootswatch as a tribute to the classic RSS color scheme: orange and white.