Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lyz-code/mkdocs-newsletter
Automatically create newsletters from the changes in a mkdocs repository
https://github.com/lyz-code/mkdocs-newsletter
mkdocs-newsletter mkdocs-plugin
Last synced: about 1 month ago
JSON representation
Automatically create newsletters from the changes in a mkdocs repository
- Host: GitHub
- URL: https://github.com/lyz-code/mkdocs-newsletter
- Owner: lyz-code
- License: gpl-3.0
- Created: 2021-02-10T16:13:44.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T12:10:11.000Z (7 months ago)
- Last Synced: 2024-11-09T18:41:53.551Z (about 1 month ago)
- Topics: mkdocs-newsletter, mkdocs-plugin
- Language: Python
- Homepage: https://lyz-code.github.io/mkdocs-newsletter
- Size: 13.3 MB
- Stars: 31
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# MkDocs Newsletter
[](https://github.com/lyz-code/mkdocs-newsletter/actions)
[](https://github.com/lyz-code/mkdocs-newsletter/actions)
[](https://coveralls.io/github/lyz-code/mkdocs-newsletter?branch=main)
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](rss_feeds.md) 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](https://semver.org/) or our
[enhanced version](docs/usage.md#commit-message-guidelines) 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](https://github.com/Guts/mkdocs-rss-plugin) instead if this
workflow doesn't feel good.
Check [a live
version](https://lyz-code.github.io/blue-book/newsletter/0_newsletter_index/).
## Help
See [documentation](https://lyz-code.github.io/mkdocs-newsletter) for more details.
## [Installing](https://lyz-code.github.io/mkdocs-newsletter/install/)
You should check the [install
docs](https://lyz-code.github.io/mkdocs-newsletter/install/), but in short,
you'll need to:
```bash
pip install mkdocs-newsletter
```
And enable this plugin, by changing your `mkdocs.yml`.
```yaml
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](https://lyz-code.github.io/mkdocs-newsletter/contributing).
## Donations
or
[](https://ko-fi.com/T6T3GP0V8)
If you are using some of my open-source tools, have enjoyed them, and want to
say "thanks", this is a very strong way to do it.
If your product/company depends on these tools, you can sponsor me to ensure I
keep happily maintaining them.
If these tools are helping you save money, time, effort, or frustrations; or
they are helping you make money, be more productive, efficient, secure, enjoy a
bit more your work, or get your product ready faster, this is a great way to
show your appreciation. Thanks for that!
And by sponsoring me, you are helping make these tools, that already help you,
sustainable and healthy.
## License
GPLv3