Automatically create newsletters from the changes in a mkdocs repository
Project description
MkDocs Newsletter
MkDocs plugin to show the changes of documentation repositories in a user friendly format, at the same time that it's easy for the authors to maintain.
It creates daily, weekly, monthly and yearly newsletter articles with the
changes of each period. Those pages, stored under the Newsletters section, are
filled with the changes extracted from the commit messages of the git history.
The changes are grouped by categories, subcategories and then by file using the
order of the site's navigation structure. RSS feeds are also
created for each newsletter type, so it's easy for people to keep updated with
the evolution of the site.
It assumes that you're using semantic versioning or our enhanced version to create your commits. Only those changes that are interesting to the reader will be added to the newsletter. You can use mkdocs-rss-plugin instead if this workflow doesn't feel good.
Check a live version.
Help
See documentation for more details.
Installing
You should check the install docs, but in short, you'll need to:
pip install mkdocs-newsletter
And enable this plugin, by changing your mkdocs.yml.
plugins:
- git-revision-date-localized:
type: timeago
- autolinks
- section-index
- mkdocs-newsletter
Contributing
For guidance on setting up a development environment, and how to make a contribution to mkdocs-newsletter, see Contributing to mkdocs-newsletter.
License
GPLv3
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
