diff --git a/docs/index.md b/docs/index.md index e69de29bb..d39f87962 100644 --- a/docs/index.md +++ b/docs/index.md @@ -0,0 +1,30 @@ +# Material for MkDocs + +## Beautiful project documentation + +Material is a theme for [MkDocs][1], an excellent static site generator geared +towards project documentation. It is built using Google's [Material Design][2] +guidelines. + +[![Material for MkDocs](images/material.png)](images/material.png) + + [1]: http://www.mkdocs.org + [2]: https://www.google.com/design/spec/material-design + +## Quick start + +Install the latest version of Material with `pip`: + +``` sh +pip install mkdocs-material +``` + +Add the following line to your `mkdocs.yml`: + +``` yaml +theme: 'material' +``` + +For detailed instructions see the [getting started guide][3]. + + [3]: getting-started.md