Skip to main content

Add badges to your MkDocs page

Project description


PyPI version License Python versions

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


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.


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.4.2

  • Detect markdown tables even if they have only a single dash in the header. Fixes #4
  • Option to disable warnings (use this at your own risk) by adding disable_warnings: True to the plugin config in your mkdocs.yml

Version 0.4.1

  • Now requires MkDocs 1.5 or newer
  • The included script is now marked as async by default, maybe improving loading times a tiny bit. This can be disabled by adding async: False to the plugin config in your mkdocs.yml

Version 0.4.0

  • Now requires MkDocs 1.4 or newer
  • Updated the layout rules for badges. This should better handle oversized contents (like images or very long texts).

Version 0.3.4

  • Added single element badges

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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-badges-0.4.2.tar.gz (15.7 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_badges-0.4.2-py3-none-any.whl (16.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page