Go to file
2019-05-13 19:06:44 +02:00
.github fix(core): update 2019-05-13 19:04:33 +02:00
docs fix(core): update 2019-05-13 19:04:33 +02:00
material fix(core): update 2019-05-13 19:04:33 +02:00
src fix(core): update 2019-05-13 19:04:33 +02:00
.babelrc fix(core): update 2019-05-13 19:04:33 +02:00
.editorconfig fix(core): update 2019-05-13 19:04:33 +02:00
.env fix(core): update 2019-05-13 19:04:33 +02:00
.eslintignore fix(core): update 2019-05-13 19:04:33 +02:00
.eslintrc fix(core): update 2019-05-13 19:04:33 +02:00
.gitignore fix(core): update 2019-05-13 19:04:33 +02:00
.gitlab-ci.yml fix(core): update 2019-05-13 19:04:33 +02:00
.modernizr-autorc fix(core): update 2019-05-13 19:04:33 +02:00
.stylelintignore fix(core): update 2019-05-13 19:04:33 +02:00
.stylelintrc fix(core): update 2019-05-13 19:04:33 +02:00
.travis.sh fix(core): update 2019-05-13 19:04:33 +02:00
.travis.yml fix(core): update 2019-05-13 19:04:33 +02:00
.travisignore fix(core): update 2019-05-13 19:04:33 +02:00
CHANGELOG fix(core): update 2019-05-13 19:04:33 +02:00
CODE_OF_CONDUCT.md fix(core): update 2019-05-13 19:04:33 +02:00
CONTRIBUTING.md fix(core): update 2019-05-13 19:04:33 +02:00
Dockerfile fix(core): update 2019-05-13 19:04:33 +02:00
LICENSE fix(core): update 2019-05-13 19:06:44 +02:00
Makefile fix(core): update 2019-05-13 19:04:33 +02:00
MANIFEST.in fix(core): update 2019-05-13 19:04:33 +02:00
mkdocs.yml fix(core): update 2019-05-13 19:04:33 +02:00
package-lock.json 4.2.1 2019-05-13 19:04:34 +02:00
package.json 4.2.1 2019-05-13 19:04:34 +02:00
README.md fix(core): update 2019-05-13 19:06:44 +02:00
requirements.txt fix(core): update 2019-05-13 19:04:33 +02:00
setup.py fix(core): update 2019-05-13 19:04:33 +02:00
webpack.config.js fix(core): update 2019-05-13 19:04:33 +02:00

Travis Downloads Gitter PyPI dependabot

Material for MkDocs

A Material Design theme for MkDocs.

Material for MkDocs

Quick start

Install the latest version of Material with pip:

pip install mkdocs-material

Append the following line to your project's mkdocs.yml:

theme:
  name: '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 in 36 languages 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 (F or S), intelligent grouping of search results, search term highlighting and lazy loading.

For detailed installation instructions and a demo, visit https://squidfunk.github.io/mkdocs-material/

License

MIT License

Copyright (c) 2016-2019 Martin Donath Copyright (c) 2019 Lossless GmbH hello@lossless.com

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.