Skip to main content

MkDocs plugin which generates a static RSS feed using git log and page.meta.

Project description

MkDocs RSS plugin

PyPi version badge PyPI - Downloads PyPI - Python Version

Code style: black Imports: isort pre-commit Documentation Status

A plugin for MkDocs, the static site generator, which creates RSS 2.0 feeds using the creation and modification dates from git log.

Usage

Typical mkdocs.yml:

plugins:
  - rss:
      abstract_chars_count: 160
      date_from_meta:
        as_creation: "date"
        as_update: false
        datetime_format: "%Y-%m-%d %H:%M"
      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: ".*"

For further information, see the user documentation.

Development

For further information, see the technical documentation.

Project details


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-0.14.0.tar.gz (13.8 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_rss_plugin-0.14.0-py2.py3-none-any.whl (26.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page