2016-02-09 23:48:01 +01:00
|
|
|
# Material
|
|
|
|
|
|
2017-01-12 00:49:28 +01:00
|
|
|
[![Travis][travis-image]][travis-link]
|
2017-01-12 20:58:19 +01:00
|
|
|
[![Dependencies][deps-image]][deps-link]
|
2017-01-12 00:49:28 +01:00
|
|
|
[![Codacy][codacy-image]][codacy-link]
|
|
|
|
|
[![PyPI][pypi-image]][pypi-link]
|
2016-02-09 23:48:01 +01:00
|
|
|
|
2017-01-12 20:15:30 +01:00
|
|
|
A Material Design theme for [MkDocs](http://www.mkdocs.org).
|
2016-02-09 23:48:01 +01:00
|
|
|
|
2017-01-12 20:58:19 +01:00
|
|
|
TBD: [](http://squidfunk.github.io/mkdocs-material/)
|
2017-01-12 00:49:28 +01:00
|
|
|
|
|
|
|
|
[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg
|
|
|
|
|
[travis-link]: https://travis-ci.org/squidfunk/mkdocs-material
|
2017-01-12 20:58:19 +01:00
|
|
|
[deps-image]: https://david-dm.org/squidfunk/mkdocs-material/dev-status.svg
|
|
|
|
|
[deps-link]: https://david-dm.org/squidfunk/mkdocs-material?type=dev
|
2017-01-12 00:49:28 +01:00
|
|
|
[codacy-image]: https://api.codacy.com/project/badge/Grade/fe07aa1fa91d453cb69711d3885c5d7e
|
|
|
|
|
[codacy-link]: https://www.codacy.com/app/squidfunk/mkdocs-material?utm_source=github.com&utm_medium=referral&utm_content=squidfunk/mkdocs-material&utm_campaign=Badge_Grade
|
|
|
|
|
[pypi-image]: https://img.shields.io/pypi/v/mkdocs-material.svg
|
|
|
|
|
[pypi-link]: https://pypi.python.org/pypi/mkdocs-material
|
2016-02-11 12:33:28 +01:00
|
|
|
|
|
|
|
|
## Quick start
|
2016-02-09 23:48:01 +01:00
|
|
|
|
|
|
|
|
Install with `pip`:
|
|
|
|
|
|
|
|
|
|
``` sh
|
|
|
|
|
pip install mkdocs-material
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Add the following line to your `mkdocs.yml`:
|
|
|
|
|
|
|
|
|
|
``` yaml
|
|
|
|
|
theme: 'material'
|
|
|
|
|
```
|
|
|
|
|
|
2016-02-11 12:33:28 +01:00
|
|
|
For detailed installation instructions and a demo, visit
|
|
|
|
|
http://squidfunk.github.io/mkdocs-material/
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2016-02-17 18:08:11 +01:00
|
|
|
**MIT License**
|
|
|
|
|
|
2017-01-12 00:49:28 +01:00
|
|
|
Copyright (c) 2016-2017 Martin Donath
|
2016-02-11 12:33:28 +01:00
|
|
|
|
|
|
|
|
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.
|
