38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
|
---
|
|||
|
|
title: Adding a badge to your project
|
|||
|
|
date: 2023-11-30
|
|||
|
|
authors: [squidfunk]
|
|||
|
|
slug: adding-a-badge-to-your-project
|
|||
|
|
description: >
|
|||
|
|
Share the love – you can now add a badge to your README, showing that your
|
|||
|
|
project is built with Material for MkDocs
|
|||
|
|
categories:
|
|||
|
|
- 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][badge]](#usage)
|
|||
|
|
|
|||
|
|
<!-- more -->
|
|||
|
|
|
|||
|
|
## Usage
|
|||
|
|
|
|||
|
|
Just copy the following snippet and paste it into your project's `README.md`:
|
|||
|
|
|
|||
|
|
``` markdown
|
|||
|
|
[](https://squidfunk.github.io/mkdocs-material/)
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
[Simple Icons]: https://simpleicons.org/
|
|||
|
|
[Shields.io]: https://shields.io/
|
|||
|
|
[badge]: https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white
|