MkDocs plugin which generates a static RSS feed using git log and page.meta.
Project description
MkDocs RSS plugin
A plugin for MkDocs, the static site generator, which creates RSS 2.0 feeds using the creation and modification dates from git log and page metadata (YAML frontmatter).
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
categories:
- tags
comments_path: "#__comments"
date_from_meta:
as_creation: "date"
as_update: false
datetime_format: "%Y-%m-%d %H:%M"
default_timezone: Europe/Paris
default_time: "09:30"
enabled: true
feed_ttl: 1440
image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png
length: 20
pretty_print: false
match_path: ".*"
url_parameters:
utm_source: "documentation"
utm_medium: "RSS"
utm_campaign: "feed-syndication"
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
Clone the repository:
# install development dependencies
python -m pip install -U -r requirements/development.txt
# alternatively: pip install -e .[dev]
# install project as editable
python -m pip install -e .
# install git hooks
pre-commit install
# run tests
pytest
# install dependencies for documentation
python -m pip install -U -r requirements/documentation.txt
# alternatively: pip install -e .[doc]
Then follow the contribution guidelines.
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocs-rss-plugin-1.4.1.tar.gz
(17.9 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_rss_plugin-1.4.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01f0019cedc07cf803d39da7ddbfc8fbcf279330a4deed10b847128580e906fb |
|
MD5 | 2a49bd2e01d3ef8da2c980b4d88f6fa6 |
|
BLAKE2b-256 | 82a87b44f06110550a5b4f08a941cb5191f843843f411f943b3aaca9d936ed24 |