1
1
# Getting started
2
2
3
- Material for MkDocs is a theme for [ MkDocs] , a static site generator geared
4
- towards (technical) project documentation. If you're familiar with Python, you
5
- can install Material for MkDocs with [ ` pip ` ] [ pip ] , the Python package manager.
6
- If not, we recommend using [ ` docker ` ] [ docker ] .
3
+ Material for MkDocs is a powerful documentation framework on top of [ MkDocs] ,
4
+ a static site generator for project documentation.[ ^ 1 ] If you're familiar with
5
+ Python, you can install Material for MkDocs with [ ` pip ` ] [ pip ] , the Python
6
+ package manager. If not, we recommend using [ ` docker ` ] [ docker ] .
7
+
8
+ [ ^ 1 ] :
9
+ In 2016, Material for MkDocs started out as a simple theme for MkDocs, but
10
+ over the course of several years, it's now much more than that – with the
11
+ many built-in plugins, settings, and countless customization abilities,
12
+ Material for MkDocs is now one of the simplest and most powerful frameworks
13
+ for creating documentation for your project.
7
14
8
15
[ MkDocs ] : https://www.mkdocs.org
9
16
[ pip ] : #with-pip
@@ -29,7 +36,7 @@ Material for MkDocs with:
29
36
pip install mkdocs-material=="9.*" # (1)!
30
37
```
31
38
32
- 1. Material for MkDocs uses [semantic versioning][^1 ], which is why it's a
39
+ 1. Material for MkDocs uses [semantic versioning][^2 ], which is why it's a
33
40
good idea to limit upgrades to the current major version.
34
41
35
42
This will make sure that you don't accidentally [upgrade to the next
@@ -47,7 +54,7 @@ Material for MkDocs with:
47
54
pip install -r requirements.txt
48
55
```
49
56
50
- [ ^ 1 ] :
57
+ [ ^ 2 ] :
51
58
Note that improvements of existing features are sometimes released as
52
59
patch releases, like for example improved rendering of content tabs, as
53
60
they're not considered to be new features.
0 commit comments