Skip to content

Commit b96f240

Browse files
committed
Added blog post on new badge
1 parent d0a536a commit b96f240

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
date: 2023-11-30
3+
authors: [squidfunk]
4+
slug: adding-a-badge-to-your-project
5+
description: >
6+
Share the love – you can now add a badge to your README, showing that your
7+
project is built with Material for MkDocs
8+
categories:
9+
- General
10+
---
11+
12+
# Adding a :simple-materialformkdocs: badge to your project
13+
14+
__You enjoy working with Material for MkDocs? Share the love! You can now add
15+
a badge to your project's README, showing that your project is built with
16+
Material for MkDocs.__
17+
18+
Material for MkDocs' logo was just added to [Simple Icons], which is used by
19+
[Shields.io] to include logos in badges. We generated a badge for you, which
20+
you can add to your project's README:
21+
22+
[![Material for MkDocs][badge]](#usage)
23+
24+
<!-- more -->
25+
26+
## Usage
27+
28+
Just copy the following snippet and paste it into your project's `README.md`:
29+
30+
``` markdown
31+
[![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/)
32+
```
33+
34+
[Simple Icons]: https://simpleicons.org/
35+
[Shields.io]: https://shields.io/
36+
[badge]: https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white

0 commit comments

Comments
 (0)