Metadata-Version: 2.1
Name: mkdocs-newsletter
Version: 0.2.0
Summary: Automatically create newsletters from the changes in a mkdocs repository
Home-page: https://github.com/lyz-code/mkdocs-newsletter
Author: Lyz
Author-email: lyz-code-security-advisories@riseup.net
License: GNU General Public License v3
Description: # MkDocs Newsletter
        
        [![Actions Status](https://github.com/lyz-code/mkdocs-newsletter/workflows/Tests/badge.svg)](https://github.com/lyz-code/mkdocs-newsletter/actions)
        [![Actions Status](https://github.com/lyz-code/mkdocs-newsletter/workflows/Build/badge.svg)](https://github.com/lyz-code/mkdocs-newsletter/actions)
        [![Coverage Status](https://coveralls.io/repos/github/lyz-code/mkdocs-newsletter/badge.svg?branch=master)](https://coveralls.io/github/lyz-code/mkdocs-newsletter?branch=master)
        
        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 git history and the commit messages.
        The changes are grouped by categories, subcategories and then by file using the
        order of the site's navigation structure.
        
        It assumes that you're using [semantic versioning](https://semver.org/) or our
        [enhanced version](#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.
        
        ![ ](docs/img/screencast.gif)
        
        Check [the live
        version](https://lyz-code.github.io/blue-book/newsletter/2021_02).
        
        ## Help
        
        See [documentation](https://lyz-code.github.io/mkdocs-newsletter) for more details.
        
        ## Installing
        
        ```bash
        pip install 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).
        
        ## License
        
        GPLv3
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Utilities
Classifier: Natural Language :: English
Requires-Python: >=3.6
Description-Content-Type: text/markdown
