Skip to content

Commit a40b70c

Browse files
committed
📝 docs(mkdocs): add some cool examples to docs/index.md
1 parent 04850e6 commit a40b70c

1 file changed

Lines changed: 94 additions & 0 deletions

File tree

template/docs/index.md.jinja

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,100 @@
77

88
{{ project_description }}
99

10+
# Installation
11+
12+
Griffe is a Python package, so you can install it with your favorite Python package installer or dependency manager.
13+
14+
TIP: **[Griffe Insiders](modules.md), a version with [*more features*](insiders/index.md#whats-in-it-for-me), is also available to sponsors :octicons-heart-fill-24:{ .heart .pulse }**
15+
16+
17+
TIP: [Griffe Insiders](modules.md), a version with [*more features*](insiders/index.md#whats-in-it-for-me), is also available to sponsors :octicons-heart-fill-24:{ .heart .pulse }
18+
19+
> INFO: some info
20+
>
21+
> > WARNING: a warning
22+
23+
> IMPORTANT:
24+
> **hi**
25+
26+
> INFO:
27+
> **hi** there
28+
29+
INFO:
30+
**hi** there
31+
32+
INFO: **hi** there
33+
34+
NOTE: some note
35+
36+
CAUTION: some caution
37+
38+
DANGER: a danger
39+
40+
ERROR: an error
41+
42+
SUCCESS: a success
43+
44+
QUESTION: a question
45+
46+
TODO: a todo
47+
48+
## Install as a tool & library
49+
50+
=== ":simple-python: pip"
51+
```bash
52+
pip install griffe
53+
```
54+
55+
<div class="result" markdown>
56+
57+
[pip](https://pip.pypa.io/en/stable/) is the main package installer for Python.
58+
59+
</div>
60+
61+
=== ":simple-pdm: pdm"
62+
```bash
63+
pdm add griffe
64+
```
65+
66+
<div class="result" markdown>
67+
68+
[PDM](https://pdm-project.org/en/latest/) is an all-in-one solution for Python project management.
69+
70+
</div>
71+
72+
=== ":simple-poetry: poetry"
73+
```bash
74+
poetry add griffe
75+
```
76+
77+
<div class="result" markdown>
78+
79+
[Poetry](https://python-poetry.org/) is an all-in-one solution for Python project management.
80+
81+
</div>
82+
83+
=== ":simple-rye: rye"
84+
```bash
85+
rye add griffe
86+
```
87+
88+
<div class="result" markdown>
89+
90+
[Rye](https://rye.astral.sh/) is an all-in-one solution for Python project management, written in Rust.
91+
92+
</div>
93+
94+
=== ":simple-astral: uv"
95+
```bash
96+
uv add griffe
97+
```
98+
99+
<div class="result" markdown>
100+
101+
[uv](https://docs.astral.sh/uv/) is an extremely fast Python package and project manager, written in Rust.
102+
103+
</div>
10104
## Code Annotation Examples
11105

12106
### Codeblocks

0 commit comments

Comments
 (0)