CSS HTML JavaScript Shell Makefile Python Dockerfile
Clone or download
Permalink
Failed to load latest commit information.
.githooks Replaced yarn with npm 5.6 Feb 21, 2018
.github Added mkdocs.yml as a requirement to issue template Jan 22, 2017
docs Fixed broken links in specimen documentation Aug 9, 2018
material Prepare 3.0.3 release Aug 7, 2018
src Fixed #841: Additional path levels for extra CSS and JS Aug 7, 2018
.babelrc Refactored Gulp build pipeline with Webpack Nov 21, 2017
.editorconfig Updated copyright notice Jan 13, 2018
.env Prepare 3.0.1 release Aug 5, 2018
.eslintignore Added temporary scripts for testing Apr 26, 2018
.eslintrc Upgraded dependencies Jun 13, 2017
.gitignore Prepare 3.0.1 release Aug 5, 2018
.modernizr-autorc Refactored Gulp build pipeline with Webpack Nov 21, 2017
.stylelintignore Updated copyright notice Jan 13, 2018
.stylelintrc Upgraded stylelint Dec 12, 2017
.travis.sh Fix Travis after success script Aug 5, 2018
.travis.yml Fixed Travis build Aug 5, 2018
.travisignore Remove .travisignore from .travisignore Apr 8, 2017
CHANGELOG Prepare 3.0.3 release Aug 7, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 21, 2017
CONTRIBUTING.md Fixed protocol for links in documentation Jun 11, 2018
Dockerfile Fixed Travis build Aug 5, 2018
LICENSE Updated copyright notice Jan 13, 2018
MANIFEST.in Try to fix Travis build Jun 10, 2018
Makefile Replaced yarn with npm 5.6 Feb 21, 2018
README.md Added Serbian and Serbo-Croatian translations Aug 4, 2018
mkdocs.yml Upgraded MkDocs to 1.0 Aug 4, 2018
package-lock.json Prepare 3.0.3 release Aug 7, 2018
package.json Prepare 3.0.3 release Aug 7, 2018
requirements.txt Upgraded MkDocs to 1.0 Aug 4, 2018
setup.py Updated copyright notice Jan 13, 2018
webpack.config.js Added support for web font minification in production Jun 18, 2018

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 31 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.