Skip to content

Commit 56f7b99

Browse files
committed
feat(mkdocs): add icons to pages
1 parent 33a8edb commit 56f7b99

File tree

8 files changed

+29
-0
lines changed

8 files changed

+29
-0
lines changed

changelog.d/+39467bb1.added.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add icons to MkDocs documentation pages.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1+
---
2+
icon: material/rocket
3+
---
4+
15
--8<-- "CHANGELOG.md"

template/{% if docs %}docs{% endif %}/{% if docs == 'mkdocs' %}.{% endif %}/index.md.jinja

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: material/home
3+
---
4+
15
# {{ project_name }}
26

37
[![PyPI](https://img.shields.io/pypi/v/{{ distribution_name }})](https://pypi.org/project/{{ distribution_name }}/)
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: material/license
3+
---
4+
15
```text
26
--8<-- "LICENSE"
37
```
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1+
---
2+
icon: material/book
3+
---
4+
15
# ::: {{ package_name }}

template/{% if docs %}docs{% endif %}/{% if docs == 'mkdocs' %}.{% endif %}/reference/index.md.jinja

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: material/book-open
3+
---
4+
15
# Reference
26

37
The reference section provides:

template/{% if docs %}docs{% endif %}/{% if docs == 'mkdocs' %}.{% endif %}/reference/{% if cli == 'click' %}cli.md{% endif %}.jinja

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: material/play
3+
---
4+
15
# Commands
26

37
::: mkdocs-click

template/{% if docs %}docs{% endif %}/{% if docs == 'mkdocs' %}.{% endif %}/reference/{% if cli and cli != 'click' %}cli.md{% endif %}.jinja

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: material/play
3+
---
4+
15
# Commands
26

37
## {{ distribution_name }}

0 commit comments

Comments
 (0)