mkdocs-material/docs/index.md

# Material <small>for MkDocs</small>


<style>
  .md-typeset .admonition.seealso .admonition-title::before {
    content: "question_answer";
  }
</style>

!!! seealso "[User Survey 2020][0]{ target="_blank" rel="noopener" } – tell us about you, it takes only 2 minutes of your time!"

    __Material for MkDocs 5__ is around the corner and we would like to learn
    more __about you__ and __how you use__ this project. [Take the survey][0]{ target="_blank" rel="noopener" }
    and help us learn about your experiences, so we can make this project even
    better!

  [0]: https://forms.gle/4mJgtJRbvZr1spk38

## 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
```

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 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 (<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