MkDocs changelog feed plugin
MkDocs version 1 plugin that adds RSS and Atom feeds for a changelog.
This plugin takes the rendered HTML output of the page specified by the changelog_file setting, splits it into sections for each changelog entry, and generates RSS and Atom feeds with items for each of those entries. Then, links to the feeds are added to the page.
The page is expected to be in the Keep a Changelog format, e.g. every entry starts with a second level heading, the version title and the date have to be separated by -1, the date has to be in ISO 8601 format, etc.
Installation
pip install mkdocs-changelog-feed-plugin
Usage
In mkdocs.yaml, set site_url and add the plugin to plugins:
site_name: My Docs
site_url: https://mydocs.example.com/
plugins:
- search
- changelog_feed
Plugin configuration
changelog_file
The file within your docs directory containing the changelog.
default: CHANGELOG.md
feed_title
The feed's title.
Defaults to "page name - site name", if not set.
default: null
feed_description
The feed's description (RSS)/subtitle (Atom).
default: null
remove_permalinks
Remove permalinks added by Python-Markdown's Table of Contents extension from the feeds.
default: true
links_icon
Icon to be displayed next to the links to the feeds at the top of the page.
default: <i class="fa fa-square-rss"></i>
Licence
This project is licenced under the AGPL-3.0 license.
-
Or – or —, in case something like the SmartyPants extension replaces the
-character. ↩
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-changelog-feed-plugin 2026.5.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs_changelog_feed_plugin-2026.5.14.tar.gz | 18.6 kB | Without provenance | Details for mkdocs_changelog_feed_plugin-2026.5.14.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_changelog_feed_plugin-2026.5.14-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_changelog_feed_plugin-2026.5.14-py3-none-any.whl |
Total release size: 42.3 kB
Release files / mkdocs_changelog_feed_plugin-2026.5.14.tar.gz
| Download URL | mkdocs_changelog_feed_plugin-2026.5.14.tar.gz |
|---|---|
| Size | 18.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
866ab477069867d1c1e5606ade7fcf39aa5a3de11428ce2d159fc0b466302bc2
|
|
BLAKE2b-256 checksum How to use checksums |
d23ec9b029f16b27b50eb09fb094c921d7002568eab59453af87efe9ffd38c48
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.12.10 Windows/11
|
Release files / mkdocs_changelog_feed_plugin-2026.5.14-py3-none-any.whl
| Download URL | mkdocs_changelog_feed_plugin-2026.5.14-py3-none-any.whl |
|---|---|
| Size | 23.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
47871723edf19a5bd989ff3599a950430a1dbc28174dff6c7007d9c79dba4224
|
|
BLAKE2b-256 checksum How to use checksums |
a4a1a1d780c36a98def5a14910be38e0e2cbe2721291ca3ad53144fb715c56b3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.12.10 Windows/11
|
Security for mkdocs-changelog-feed-plugin 2026.5.14
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
