MkDocs RSS plugin
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).
Installation
pip install mkdocs-rss-plugin
Usage
Minimal mkdocs.yml configuration:
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.
Minimal plugin option:
plugins:
- rss
Full options:
plugins:
- rss:
abstract_chars_count: 160 # -1 for full content
abstract_delimiter: <!-- more -->
categories:
- tags
comments_path: "#__comments"
date_from_meta:
as_creation: "date" # means from page.meta.date
as_update: "git" # means from git log
datetime_format: "%Y-%m-%d %H:%M"
default_time: "09:30"
default_timezone: Europe/Paris
enabled: true
feed_description: "My custom feed description" # MkDocs site_description: will be used if this key is not present
feeds_filenames:
json_created: feed_json_created.json
json_updated: feed_json_updated.json
rss_created: feed_rss_created.xml
rss_updated: feed_rss_updated.xml
feed_title: "My custom feed title" # MkDocs site_name: will be used if this key is not present
feed_ttl: 1440
image: https://github.com/Guts/mkdocs-rss-plugin/blob/main/docs/assets/logo_rss_plugin_mkdocs.png?raw=true
json_feed_enabled: true
length: 20
match_path: ".*"
pretty_print: false
rss_feed_enabled: true
url_parameters:
utm_source: "documentation"
utm_medium: "RSS"
utm_campaign: "feed-syndication"
use_git: true
use_material_blog: true
use_material_social_cards: true
For further information, see the user documentation.
Following initiative from the author of Material for MkDocs, this plugin provides its own JSON schema to validate configuration: source - documentation.
Development
Once you cloned the repository:
# install project as editable
python -m pip install -e .
# including development dependencies
python -m pip install -e .[dev]
# including documentation dependencies
python -m pip install -e .[docs]
# including testing dependencies
python -m pip install -e .[test]
# all inclusive
python -m pip install -e .[dev,docs,test]
# install git hooks
pre-commit install
Then follow the contribution guidelines.
Run the tests
# install development dependencies
python -m pip install -e .[test]
# run tests
pytest
Build the documentation
# install dependencies for documentation
python -m pip install -e .[docs]
# build the documentation
mkdocs build
Release workflow
- Fill the
CHANGELOG.md - Change the version number in
__about__.py - Apply a git tag with the relevant version:
git tag -a 0.3.0 {git commit hash} -m "New awesome feature" - Push tag to main branch:
git push origin 0.3.0
1 maintainer
Release files for mkdocs-rss-plugin 1.19.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_rss_plugin-1.19.0.tar.gz | 573.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_rss_plugin-1.19.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 606.3 kB
Release files / mkdocs_rss_plugin-1.19.0.tar.gz
| Download URL | mkdocs_rss_plugin-1.19.0.tar.gz |
|---|---|
| Size | 573.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0b9b7f14688393e5bd7d26a6dc14dfd2b228a8cdfe5b598a6677589b2159d957
|
|
BLAKE2b-256 checksum How to use checksums |
22e870055ec6d7105c0f7c84918e0f98180443b5065469b2877aca43067a5709
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 17, 2026.
Transparency logRelease files / mkdocs_rss_plugin-1.19.0-py3-none-any.whl
| Download URL | mkdocs_rss_plugin-1.19.0-py3-none-any.whl |
|---|---|
| Size | 33.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5fdaffdee96745011c7c7786ed52b42a2d751f3aad84c188ffbedeb5a6e2994a
|
|
BLAKE2b-256 checksum How to use checksums |
9f001f2144fad080706c1ebebef83b7b5c0f8d80f9a2a06b33baabb94e33c84e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 17, 2026.
Transparency log
