mkdocs-material/README.md

# Material

[![PyPI Downloads][pypi-dl-image]][pypi-dl-link]
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Release Status][release-image]][release-link]
[![License][license-image]][license-link]

A material design theme for MkDocs.

![iOS](docs/images/screen.png)

Install with `pip`:

``` sh
pip install mkdocs-material
```

Add the following line to your `mkdocs.yml`:

``` yaml
theme: 'material'
```

For detailed installation instructions and a demo, visit [squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/)

[pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png
[pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material
[release-image]: https://img.shields.io/github/release/squidfunk/mkdocs-material.svg
[release-link]: https://github.com/squidfunk/mkdocs-material/releases/latest
[license-image]: https://img.shields.io/github/license/squidfunk/mkdocs-material.svg
[license-link]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE