|
|
||
|---|---|---|
| .github | ||
| docs | ||
| material | ||
| src | ||
| .gitignore | ||
| .travis.yml | ||
| bower.json | ||
| CHANGELOG | ||
| Gulpfile.js | ||
| LICENSE | ||
| MANIFEST.in | ||
| mkdocs.yml | ||
| package.json | ||
| README.md | ||
| setup.py | ||
Material
A material design theme for MkDocs.
Note: the theme is currently undergoing a complete rewrite for 1.0.0 which should be released shortly.
- To get a glimpse, checkout the rework branch
- To give feedback on the rework version, please see issues #46
Quick start
Install with pip:
pip install mkdocs-material
Add the following line to your mkdocs.yml:
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.