Skip to content

Commit 883a69d

Browse files
committed
Documentation
1 parent c2e5558 commit 883a69d

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66

77
<p align="center">
88
<strong>
9-
A
10-
<a href="https://material.io/">Material Design</a>
11-
theme for
9+
A powerful documentation framework on top of
1210
<a href="https://www.mkdocs.org/">MkDocs</a>
1311
</strong>
1412
</p>

docs/getting-started.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# Getting started
22

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.
714

815
[MkDocs]: https://www.mkdocs.org
916
[pip]: #with-pip
@@ -29,7 +36,7 @@ Material for MkDocs with:
2936
pip install mkdocs-material=="9.*" # (1)!
3037
```
3138

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
3340
good idea to limit upgrades to the current major version.
3441

3542
This will make sure that you don't accidentally [upgrade to the next
@@ -47,7 +54,7 @@ Material for MkDocs with:
4754
pip install -r requirements.txt
4855
```
4956

50-
[^1]:
57+
[^2]:
5158
Note that improvements of existing features are sometimes released as
5259
patch releases, like for example improved rendering of content tabs, as
5360
they're not considered to be new features.

0 commit comments

Comments
 (0)