mkdocs-rss-plugin
MkDocs plugin to generate RSS and JSON feeds using Mkdocs site configuration, git log and Mkdocs pages'meta.
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; git must be available in the project for date extraction from git log.
- Low friction install with six runtime dependencies.
- Active maintenance with last commit on 2026-08-03 and production-stable status.
License · maintenance · safety
MIT (permissive) — MIT license permits free use, modification, and distribution with minimal restrictions.
last release 2026-04-17 (119 days) · last repo commit 2026-08-03 · 133 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 307,186 downloads/mo, #7,777 on PyPI
Alternatives
Verify before relying
pip install mkdocs-rss-plugin
# In mkdocs.yml:
plugins:
- rss:
abstract_chars_count: 160
use_git: true- 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.
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 on it.
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
Before you install
Low friction install with six runtime dependencies. Active maintenance with last commit on 2026-08-03 and production-stable status.
Requires Python 3.10 or later; git must be available in the project for date extraction from git log.
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: trueVerify 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
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 6 packagesCacheControlGitPythonmkdocsproperdocsrequeststzdata |
| Maintenance | Actively maintained 119 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 307,186 / month, #7,777 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableIntended Audience :: DevelopersIntended Audience :: Information TechnologyOperating System :: OS IndependentProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Software Development :: DocumentationTopic :: Text Processing :: Markup :: Markdown |
Evidence: mkdocs_rss_plugin-1.19.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs rss feed generator”
- mkdocs-rss-pluginGenerates RSS 2.0 and JSON Feed 1.1 feeds for MkDocs sites,…
- feedgenGenerates web feeds in ATOM and RSS formats, with support for…
- feedparserParses Atom and RSS feeds (including RSS 0.9x, RSS 1.0, RSS 2.0, CDF,…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also feedgen · mkdocs-print-site-plugin · feedparser · feedfinder2 · mkdocs-git-revision-date-plugin · mkdocs-llmstxt · mkdocs · gnews · mkdocs-gen-files · mkdocstrings