Skip to content

Setup

Install the plugin using pip:

pip install -U mkdocs-badges

Then, add the plugin to your mkdocs.yml:

plugins:
  - search
  - badges

If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set.

More information about plugins in the MkDocs documentation.