mkdocs-material/docs/index.md

# Material <small>for MkDocs</small>

## Build beautiful 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, fully responsive and optimized for touch and pointer devices.

Material is very lightweight – it is built from scratch using Javascript and
CSS that weighs approximately 30kb (minified, gzipped and excluding Google
Fonts and Analytics). Yet, it is highly customizable and degrades gracefully in
older browsers.

  [1]: http://www.mkdocs.org
  [2]: https://www.google.com/design/spec/material-design

## Quick start

Install the latest version of Material with `pip`:

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

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

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

For detailed instructions see the [getting started guide][3].

  [3]: getting-started.md

## Features

* Beautiful, readable and very user-friendly design based on Google's Material
  Design guidelines, packed in a full responsive template with a well-defined
  and [easily customizable color palette][4], great typography, as well as a
  beautiful search interface.

* Responsive specimen like code blocks, tables that work on all screen sizes,
  working with and without JavaScript which makes it gracefully degrade in
  older browsers.

- Extra configuration options like a [project logo][5], links to
  [social accounts][6], display of the amount of stars your project has on
  GitHub and [Google Analytics integration][7].

- Easily [extendable and customizable][8] due to a well-designed asset pipeline
  built on-top of modern web technologies and modular and abstracted
  style definitions..

- Web application capability on iOS – when the page is saved to the homescreen,
  it behaves and looks like a native application.

  [4]: getting-started.md#changing-the-color-palette
  [5]: getting-started.md#adding-a-logo
  [6]: getting-started.md#adding-social-links
  [7]: getting-started.md#google-analytics-integration
  [8]: customization.md