mkdocs-material/docs/blog/posts/adding-a-badge-to-your-project.md
2023-11-30 13:30:31 +01:00

1.3 KiB
Raw Blame History

title date authors slug description categories
Adding a badge to your project 2023-11-30
squidfunk
adding-a-badge-to-your-project Share the love you can now add a badge to your README, showing that your project is built with Material for MkDocs
General

Adding a :simple-materialformkdocs: badge to your project

You enjoy working with Material for MkDocs? Share the love! You can now add a badge to your project's README, showing that your project is built with Material for MkDocs.

Material for MkDocs' logo was just added to Simple Icons, which is used by Shields.io to include logos in badges. We generated a badge for you, which you can add to your project's README:

Material for MkDocs

Usage

Just copy the following snippet and paste it into your project's README.md:

[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)