mkdocs-rss-plugin

What it is and what it does

This is a MkDocs plugin that automatically generates RSS 2.0 and JSON Feed 1.1 feeds for your documentation site. It reads publication and modification dates from your git log and page metadata (YAML frontmatter), then creates feed files that readers can subscribe to. The plugin integrates directly into MkDocs' build process and supports customization of feed content, including abstract length, categories, timezone handling, and URL parameters for tracking.

The plugin depends on mkdocs, GitPython, requests, CacheControl, properdocs, and tzdata. It runs on Python 3.10 through 3.14 and is actively maintained. Configuration is done through mkdocs.yml with sensible defaults—at minimum, you need site_name, site_description, and site_url defined, then add the rss plugin. Advanced options let you control feed titles, descriptions, item counts, date formats, and whether to generate RSS, JSON, or both.

Use it for:

• Enable readers to subscribe to documentation updates via RSS or JSON Feed readers.
• Automatically track publication and modification dates from git commits without manual frontmatter.
• Generate separate feeds for creation and update events to support different subscription workflows.
• Add UTM parameters to feed links for tracking documentation traffic from syndication channels.
• Integrate with Material for MkDocs blog features and social card generation.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Generates RSS 2.0 and JSON Feed 1.1 feeds for MkDocs sites, extracting publication dates from git history and page metadata.

Yes. The plugin is production-stable, actively maintained, has low install friction, carries no known vulnerabilities, and solves a clear problem for documentation sites that want to offer feed subscriptions. MIT licensing removes legal friction. Install if you maintain a MkDocs site and want readers to subscribe to updates.

Install

mkdocs-rss-plugin on PyPI

pip install mkdocs-rss-plugin

uv add mkdocs-rss-plugin

poetry add mkdocs-rss-plugin

Installing mkdocs-rss-plugin

Before you install

Low friction install with six runtime dependencies. Active maintenance with last commit on 2026-08-03 and production-stable status.

License in practice

MIT license permits free use, modification, and distribution with minimal restrictions.

Quickstart

pip install mkdocs-rss-plugin

# In mkdocs.yml:
plugins:
  - rss:
      abstract_chars_count: 160
      use_git: true

Requires Python 3.10 or later; git must be available in the project for date extraction from git log.

Verify before relying

• Whether the plugin correctly handles edge cases in YAML frontmatter parsing across different MkDocs themes.
• Performance impact when processing large documentation sites with extensive git history.

Package facts

Evidence: mkdocs_rss_plugin-1.19.0-py3-none-any.whl

Keywords: atom, documentation, feed, git, json-feed, mkdocs, plugin, rss

Tags

More Documentation packages