1.3 KiB
Material for MkDocs
Create beautiful project documentation
Material is a theme for MkDocs, an excellent static site generator geared towards project documentation. It is built using Google's Material Design guidelines.
Quick start
Install the latest version of Material with pip:
pip install mkdocs-material
Append the following line to your project's mkdocs.yml:
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 36 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.