Description:

mkdocstowncrier 0.1.3

mkdocs-towncrier
An insanely small plugin to add towncrier changelog draft into mkdocs







Installation
You can install the package from PyPI using:
pip install -U mkdocs-towncier

and then enabling it in your mkdocs.yml file:
plugins:
- towncrier

Usage
Using mkdocs-towncrier is as easy as adding a directive to wherever you want the draft changelog
to be added:
# Changelog

<!--- You can even specify the header value! (defaults to "Unreleased") -->
:: towncrier-draft Unreleased changes

--8<-- "CHANGELOG.md"

And that's it! Any draft fragment files will be picked up and automatically added to your pages.
Acknowledgements
This project is heavily inspired in the wonderful
sphinx-contrib/sphinxcontrib-towncrier!

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter