mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-30 18:24:35 +01:00
81 lines
3.1 KiB
Markdown
81 lines
3.1 KiB
Markdown
[![Travis][travis-image]][travis-link]
|
|
[![Gitter][gitter-image]][gitter-link]
|
|
[![Codacy][codacy-image]][codacy-link]
|
|
[![Docker][docker-image]][docker-link]
|
|
[![PyPI][pypi-image]][pypi-link]
|
|
|
|
[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg?branch=master
|
|
[travis-link]: https://travis-ci.org/squidfunk/mkdocs-material
|
|
[gitter-image]: https://img.shields.io/gitter/room/squidfunk/mkdocs-material.svg
|
|
[gitter-link]: https://gitter.im/squidfunk/mkdocs-material
|
|
[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
|
|
[docker-image]: https://img.shields.io/docker/pulls/squidfunk/mkdocs-material.svg
|
|
[docker-link]: https://hub.docker.com/r/squidfunk/mkdocs-material/
|
|
[pypi-image]: https://img.shields.io/pypi/v/mkdocs-material.svg
|
|
[pypi-link]: https://pypi.python.org/pypi/mkdocs-material
|
|
|
|
# Material for MkDocs
|
|
|
|
A Material Design theme for [MkDocs][1].
|
|
|
|
[][2]
|
|
|
|
[1]: http://www.mkdocs.org
|
|
[2]: http://squidfunk.github.io/mkdocs-material/
|
|
|
|
## Quick start
|
|
|
|
Install the latest version of Material with `pip`:
|
|
|
|
``` sh
|
|
pip install mkdocs-material
|
|
```
|
|
|
|
Append the following line to your project's `mkdocs.yml`:
|
|
|
|
``` yaml
|
|
theme: 'material'
|
|
```
|
|
|
|
## What to expect
|
|
|
|
* Responsive design and fluid layout for all kinds of screens and devices,
|
|
designed to serve your project documentation in a user-friendly way with
|
|
optimal readability.
|
|
|
|
* Easily customizable primary and accent color, fonts, favicon and logo;
|
|
straight forward localization through theme extension; integrated with Google
|
|
Analytics, Disqus and GitHub.
|
|
|
|
* Well-designed search interface accessible through hotkeys (<kbd>F</kbd> or
|
|
<kbd>S</kbd>), intelligent grouping of search results, search term
|
|
highlighting and lazy loading.
|
|
|
|
For detailed installation instructions and a demo, visit
|
|
http://squidfunk.github.io/mkdocs-material/
|
|
|
|
## License
|
|
|
|
**MIT License**
|
|
|
|
Copyright (c) 2016-2017 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.
|