mkdocs-badges
Advanced tools
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 locally with MkDocs.
A development version built with the latest changes (HEAD commit) can be found at https://mkdocs-badges-dev.six-two.dev/.
The documentation also serves as a test of the plugin, especially the files under the Tests menu item.
Build the documentation with the latest source code:
poetry install && poetry run mkdocs serve -t <theme>
Themes that should work are mkdocs, readthedocs, and material.
Lint source code:
poetry run mypy
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):
poetry install && poetry run python -m unittest
src/mkdocs_badges/assets/badge.js) which seems no longer maintained.ignore_lines_starting_with_whitespace to true.[ and ].
These values can be changed with the new settings inline_badge_start and inline_badge_end in your mkdocs.ymlwinget install badge datapip_github and pip_gitlab install badgesseparator in your mkdocs.yml^), which you can set using table_separator in your mkdocs.yml- to _ in install badge types.
This allows using both brew-formula and brew_formula notation.install_badge_data option.
Instead of removing the defaults the specified file is merged with thembrew to brew_formula and added brew_cask, docker_hub, and docker_ghcrdisable_warnings: True to the plugin config in your mkdocs.ymlasync 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|end at the end of custom badges is no longer neccessary. A simple | is enough. This shorter form is recommended from now on.docs folder in the form of a mkdocs websiteFAQs
Add badges to your MkDocs page
We found that mkdocs-badges demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
An emerging npm supply chain attack that infects repos, steals CI secrets, and targets developer AI toolchains for further compromise.
Company News
Socket is proud to join the OpenJS Foundation as a Silver Member, deepening our commitment to the long-term health and security of the JavaScript ecosystem.
Security News
npm now links to Socket's security analysis on every package page. Here's what you'll find when you click through.