mkdocs-material/README.md

<p align="center">
  <img src=".github/assets/logo.png" width="320" alt="Material for MkDocs">
</p>

<p align="center">
  <a href="https://github.com/squidfunk/mkdocs-material/actions">
    <img
      src="https://github.com/squidfunk/mkdocs-material/workflows/ci/badge.svg?branch=master"
      alt="GitHub Action"
    />
  </a>
  <a href="https://pypistats.org/packages/mkdocs-material">
    <img
      src="https://img.shields.io/pypi/dm/mkdocs-material.svg" 
      alt="Downloads"
    />
  </a>
  <a href="https://gitter.im/squidfunk/mkdocs-material">
    <img 
      src="https://badges.gitter.im/squidfunk/mkdocs-material.svg" 
      alt="Chat on Gitter"
    />
  </a>
  <a href="https://gitter.im/squidfunk/mkdocs-material">
    <img 
      src="https://img.shields.io/pypi/v/mkdocs-material.svg" 
      alt="Python Package Index"
    />
  </a>
  <a href="https://amzn.to/353WRpj">
    <img src="https://img.shields.io/static/v1?label=amazon&message=wish%20list&color=orange" />
  </a>
</p>

<p align="center">
  Create a branded static site from a set of Markdown files to host the
  documentation of your Open Source or commercial project – customizable,
  searchable, mobile-friendly, 40+ languages. Set up in 5 minutes.
</p>

<p align="center">
  <a href="https://squidfunk.github.io/mkdocs-material">
    <img src=".github/assets/screenshot.png" width=700 />
  </a>
</p>

## Features

* **It's just Markdown** – you just write your technical documentation in
  Markdown, so there's no need to know any HTML, JavaScript or CSS. Material for
  MkDocs will do the heavy lifting and generate a beautiful and functional
  website.

* **Looks great on every device**: Material for MkDocs is built...

## Quick start

Install the latest version of Material for MkDocs with `pip`:

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

Add the following line to `mkdocs.yml`:

``` yaml
theme:
  name: material
```

For detailed installation instructions and a demo, visit
[squidfunk.github.io/mkdocs-material][1]

  [1]: https://squidfunk.github.io/mkdocs-material/

## License

**MIT License**

Copyright (c) 2016-2020 Martin Donath

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.