Skip to content


PyPi version badge PyPI - Downloads PyPI - Python Version

codecov Code style: black flake8 Imports: isort pre-commit status 📚 Documentation

A plugin for MkDocs, the static site generator, which creates RSS 2.0 and JSON Feed 1.1 feeds using the creation and modification dates from git log and page metadata (YAML frontmatter).



pip install mkdocs-rss-pluginRSS plugin for Mkdocs installed! Add 'rss' to your 'plugins' section in mkdocs.yml

Then in your mkdocs.yml:

site_description: required. Used as feed mandatory channel description.
site_name: required. Used as feed mandatory channel title and items source URL label.
site_url: required. Used to build feed items URLs.

  - rss


As examples, here are the feeds generated for this documentation:

Or it could be displayed as a RSS or Feedly follow button:

RSS logo Feedly button

For JSON Feed, you can use the icon:

JSON Feed icon


See how to make your RSS and JSON discoverable.


RSS logo

  • Plugin logic is inspired from Tim Vink git-based plugins and main parts of Git stuff are nearly copied/pasted.
  • Using magic mainly from:
  • GitPython
  • Jinja2
  • Documentation colors are a tribute to the classic RSS color scheme: orange and white.
  • Logo generated with DALL·E.