Home

Quickstart

Installation:

> pip install mkdocs-rss-plugin
---> 100%
RSS 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.

plugins:
  - rss

---

Example

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

• feed_rss_created.xml and feed_json_created.json for latest created pages: W3C validator
• feed_rss_updated.xml and feed_json_updated.json for latest updated pages: W3C validator

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

{: align=middle }

Tip

See how to make your RSS and JSON discoverable.

---

Credits

• 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.