1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-01 02:27:17 +01:00
mkdocs-material/docs/index.md

31 lines
676 B
Markdown
Raw Normal View History

2016-08-07 18:01:56 +02:00
# Material <small>for MkDocs</small>
2016-02-09 21:59:37 +01:00
2017-01-12 20:15:30 +01:00
## Beautiful project documentation
2016-02-09 21:59:37 +01:00
2017-01-02 23:11:32 +01:00
Material is a theme for [MkDocs][1], an excellent static site generator geared
2017-01-12 00:49:28 +01:00
towards project documentation. It is built using Google's [Material Design][2]
2017-01-12 20:15:30 +01:00
guidelines.
2016-02-09 21:59:37 +01:00
2017-01-12 22:39:18 +01:00
[![Material for MkDocs](images/material.png)](images/material.png)
2017-01-02 23:11:32 +01:00
[1]: http://www.mkdocs.org
[2]: https://www.google.com/design/spec/material-design
2016-02-24 17:31:01 +01:00
## Quick start
2017-01-02 23:11:32 +01:00
Install the latest version of Material with `pip`:
2016-02-24 17:31:01 +01:00
``` sh
pip install mkdocs-material
```
Add the following line to your `mkdocs.yml`:
``` yaml
theme: 'material'
```
2017-01-12 00:49:28 +01:00
For detailed instructions see the [getting started guide][3].
[3]: getting-started.md