MkDocs RSS plugin#

PyPi version badge PyPI - Downloads PyPI - Python Version

Code style: black pre-commit Documentation Status

A plugin for MkDocs, the static site generator, which creates RSS 2.0 feeds using the creation and modification dates from git log.

Usage#

For further information, see the user documentation.

Development#

For further information, see the technical documentation.

Here come the feeds generated for this documentation:

Or displayed as a Feedly follow button:

Feedly button

Quickstart#

Installation:

pip install mkdocs-rss-plugin

Then in your mkdocs.yml:

plugins:
  - rss

Credits#

RSS logo

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.