mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-12 01:50:52 +01:00
57 lines
2.0 KiB
Markdown
57 lines
2.0 KiB
Markdown
# Material
|
|
|
|
[![Travis CI][travis-image]][travis-link]
|
|
[![PyPI Downloads][pypi-dl-image]][pypi-dl-link]
|
|
[![PyPI Version][pypi-v-image]][pypi-v-link]
|
|
|
|
A material design theme for [MkDocs](http://www.mkdocs.org).
|
|
|
|
[](http://squidfunk.github.io/mkdocs-material/)
|
|
|
|
## Quick start
|
|
|
|
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
|
|
http://squidfunk.github.io/mkdocs-material/
|
|
|
|
## License
|
|
|
|
**MIT License**
|
|
|
|
Copyright (c) 2016 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.
|
|
|
|
[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg
|
|
[travis-link]: https://travis-ci.org/squidfunk/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 |