--- template: overrides/home.html --- # Material for MkDocs ## 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. [![Material for MkDocs](assets/images/material.png)](assets/images/material.png) [1]: https://www.mkdocs.org [2]: https://material.io/design/ ## Quick start Install the latest version of Material with `pip`: ``` sh pip install mkdocs-material ``` Add the following line to `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 41 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 (F or S), intelligent grouping of search results, search term highlighting and lazy loading. For detailed instructions see the [getting started guide][3]. [3]: getting-started.md