You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Charles Reid 5893678ca8 init commit 7 months ago
.githooks init commit 7 months ago
.github init commit 7 months ago
docs init commit 7 months ago
material init commit 7 months ago
.babelrc init commit 7 months ago
.editorconfig init commit 7 months ago
.eslintignore init commit 7 months ago
.eslintrc init commit 7 months ago
.gitignore init commit 7 months ago
.modernizr-autorc init commit 7 months ago
.stylelintignore init commit 7 months ago
.stylelintrc init commit 7 months ago
.travis.sh init commit 7 months ago
.travis.yml init commit 7 months ago
.travisignore init commit 7 months ago
CHANGELOG init commit 7 months ago
CODE_OF_CONDUCT.md init commit 7 months ago
CONTRIBUTING.md init commit 7 months ago
Dockerfile init commit 7 months ago
LICENSE init commit 7 months ago
MANIFEST.in init commit 7 months ago
Makefile init commit 7 months ago
README.md init commit 7 months ago
__USEFUL.md init commit 7 months ago
mkdocs.yml init commit 7 months ago
package-lock.json init commit 7 months ago
package.json init commit 7 months ago
requirements.txt init commit 7 months ago
setup.py init commit 7 months ago
webpack.config.js init commit 7 months ago

README.md

Travis Gitter Codacy Docker PyPI

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 25 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-2018 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.