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" 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 project as editable python -m pip install -U -r requirements.txt # install development dependencies python -m pip install -U -r requirements/development.txt # install git hooks pre-commit install # run tests pytest # install dependencies for documentation python -m pip install -U -r requirements/documentation.txt
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.1.0.tar.gz
(16.5 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_rss_plugin-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50671e2030188da4bc01ff421d979903a01cd87b02e2ec5f430fd05d5ed55825 |
|
MD5 | d043f7da67b8ebcdaf46616332b974a5 |
|
BLAKE2-256 | 36befa62fd247636f28acc7ebb5908dc81b976c1e0118070169c3d113dbf91b1 |