1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-09-24 19:38:27 +02:00
mkdocs-material/docs/index.md

46 lines
1.2 KiB
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-11-18 18:00:39 +01:00
[![Material for MkDocs](assets/images/material.png)](assets/images/material.png)
2017-01-12 22:39:18 +01:00
2017-01-02 23:11:32 +01:00
[1]: http://www.mkdocs.org
[2]: https://material.io/guidelines/material-design/
2017-01-02 23:11:32 +01:00
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
```
Append the following line to your project's `mkdocs.yml`:
2016-02-24 17:31:01 +01:00
``` yaml
theme:
name: 'material'
2016-02-24 17:31:01 +01:00
```
## What to expect
* Responsive design and fluid layout for all kinds of screens and devices,
designed to serve your project documentation in a user-friendly way with
optimal readability.
* Easily customizable primary and accent color, fonts, favicon and logo;
straight forward localization through theme extension; integrated with Google
Analytics, Disqus and GitHub.
* Well-designed search interface accessible through hotkeys (<kbd>F</kbd> or
<kbd>S</kbd>), intelligent grouping of search results, search term
highlighting and lazy loading.
2017-01-12 00:49:28 +01:00
For detailed instructions see the [getting started guide][3].
[3]: getting-started.md