mkdocs-badges 0.3.3

Add badges to your mkdocs page

mkdocs-badges

This package allows you to add badges to your mkdocs site.

Documentation

This README is just a short intro to the package. For a quick start and detailed information please see the documentation. The documentation is also available in the docs folder of the source code and can be built localy with MkDocs.

Testing

The documentation also serves as a test of the plugin. A hidden test page is available at /test.

Build the documentation with the latest source code:

pip install . && mkdocs serve -t <theme>

Themes that sould work are mkdocs, readthedocs, and material.

Unit tests

The github repository now contains some unit test. You can run them against the current code with the following command (issued in the root directory of the repository):

pip install . && python -m unittest

Notable changes

Version 0.3.3

• Added tags badges

Version 0.3.1

• Better error handling, fixed a crash
• Started adding unit tests

Version 0.3.0

• Breaking changes to the badges formats. See the migration guide
• Added support for reference links

Version 0.2.0

• Each badge now needs to be the only thing on its line
• Badges inside code blocks are no longer parsed
• The |end at the end of custom badges is no longer neccessary. A simple | is enough. This shorter form is recommended from now on.
• Documentation is now in the docs folder in the form of a mkdocs website
• Added link badges