Material theme for mkdocs.
Charles Reid b0c6890853 Merge branch 'pull-upstream' of charlesreid1/mkdocs-material into master 8 months ago
.githooks Replaced yarn with npm 5.6 1 year ago
.github Added mkdocs.yml as a requirement to issue template 2 years ago
docs merge upstream changes in docs 8 months ago
material remove reference to non-existent feature tabs 8 months ago
.babelrc Refactored Gulp build pipeline with Webpack 1 year ago
.editorconfig Updated copyright notice 1 year ago
.eslintignore Updated copyright notice 1 year ago
.eslintrc Upgraded dependencies 1 year ago
.gitignore Replaced yarn with npm 5.6 1 year ago
.modernizr-autorc Refactored Gulp build pipeline with Webpack 1 year ago
.stylelintignore Updated copyright notice 1 year ago
.stylelintrc Upgraded stylelint 1 year ago
.travis.sh Fix typo for SSL warnings and Python ver 1 year ago
.travis.yml Replaced yarn with npm 5.6 1 year ago
.travisignore Remove .travisignore from .travisignore 2 years ago
CHANGELOG pulling upstream changes in files in top level repo dir 8 months ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 1 year ago
CONTRIBUTING.md pulling upstream changes in files in top level repo dir 8 months ago
Dockerfile pulling upstream changes in files in top level repo dir 8 months ago
LICENSE Updated copyright notice 1 year ago
MANIFEST.in pulling upstream changes in files in top level repo dir 8 months ago
Makefile Replaced yarn with npm 5.6 1 year ago
README.md Added new language to documentation 1 year ago
__USEFUL.md Update '__USEFUL.md' 10 months ago
mkdocs.yml pulling upstream changes in files in top level repo dir 8 months ago
package-lock.json pulling upstream changes in files in top level repo dir 8 months ago
package.json pulling upstream changes in files in top level repo dir 8 months ago
requirements.txt pulling upstream changes in files in top level repo dir 8 months ago
setup.py Updated copyright notice 1 year ago
webpack.config.js pulling upstream changes in files in top level repo dir 8 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 © 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.