Skip to content

MkDocs plugin to generate a RSS feeds for created and updated pages, using git log.

License

Notifications You must be signed in to change notification settings

rmorshea/mkdocs-rss-plugin

 
 

Repository files navigation

MkDocs RSS plugin

PyPi version badge PyPI - Downloads PyPI - Python Version

Code style: black 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.

About

MkDocs plugin to generate a RSS feeds for created and updated pages, using git log.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 95.1%
  • HTML 4.9%