mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-12-19 19:05:59 +01:00
51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
# Material <small>for MkDocs</small>
|
|
|
|
!!! info "Call for Contributions: Add languages/translations to Material"
|
|
|
|
Help translate Material into more languages - it's just **one click** and
|
|
takes approximately **2 minutes**: [click here](http://bit.ly/2EbzFc8)
|
|
|
|
## Create 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.
|
|
|
|
[](assets/images/material.png)
|
|
|
|
[1]: http://www.mkdocs.org
|
|
[2]: https://material.io/guidelines/material-design/
|
|
|
|
## Quick start
|
|
|
|
Install the latest version of Material with `pip`:
|
|
|
|
``` sh
|
|
pip install mkdocs-material
|
|
```
|
|
|
|
Append the following line to your project's `mkdocs.yml`:
|
|
|
|
``` yaml
|
|
theme:
|
|
name: 'material'
|
|
```
|
|
|
|
## 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 in 18
|
|
languages 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.
|
|
|
|
For detailed instructions see the [getting started guide][3].
|
|
|
|
[3]: getting-started.md
|