1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-12 01:50:52 +01:00
Documentation that simply works
Go to file
2018-12-27 13:39:30 +00:00
.githooks Replaced yarn with npm 5.6 2018-02-21 21:06:11 +01:00
.github Added mkdocs.yml as a requirement to issue template 2017-01-22 13:37:46 +01:00
docs Fixed documentation 2018-11-17 17:57:47 +01:00
material Lowercased doctype to shave of 2 byte of gzipped response 2018-12-20 12:14:03 +01:00
src Lowercased doctype to shave of 2 byte of gzipped response 2018-12-20 12:14:03 +01:00
.babelrc Refactored Gulp build pipeline with Webpack 2017-11-21 21:32:25 +01:00
.editorconfig Updated copyright notice 2018-01-13 17:36:13 +01:00
.env Prepare 3.0.1 release 2018-08-05 21:45:54 +02:00
.eslintignore Added temporary scripts for testing 2018-04-26 15:20:34 +02:00
.eslintrc Upgraded dependencies 2017-06-13 15:11:03 +02:00
.gitignore Prepare 3.0.1 release 2018-08-05 21:45:54 +02:00
.modernizr-autorc Refactored Gulp build pipeline with Webpack 2017-11-21 21:32:25 +01:00
.stylelintignore Updated copyright notice 2018-01-13 17:36:13 +01:00
.stylelintrc Upgraded stylelint 2017-12-12 22:04:31 +01:00
.travis.sh Fixed Travis build 2018-09-11 12:10:34 +02:00
.travis.yml Fixed Travis build 2018-08-05 18:38:16 +02:00
.travisignore Remove .travisignore from .travisignore 2017-04-08 18:08:12 +02:00
CHANGELOG Fixed documentation 2018-11-17 17:57:47 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-06-21 11:20:50 +02:00
CONTRIBUTING.md Fixed protocol for links in documentation 2018-06-11 09:33:42 +02:00
Dockerfile Fixed Travis build 2018-08-05 18:38:16 +02:00
LICENSE Updated copyright notice 2018-01-13 17:36:13 +01:00
Makefile Replaced yarn with npm 5.6 2018-02-21 21:06:11 +01:00
MANIFEST.in Try to fix Travis build 2018-06-10 15:28:21 +02:00
mkdocs.yml Upgraded MkDocs to 1.0 2018-08-04 19:53:13 +02:00
package-lock.json Bump webpack-manifest-plugin from 1.3.2 to 2.0.4 2018-12-27 13:39:30 +00:00
package.json Bump webpack-manifest-plugin from 1.3.2 to 2.0.4 2018-12-27 13:39:30 +00:00
README.md Prepare 3.0.6 release 2018-10-26 13:15:41 +02:00
requirements.txt Upgraded MkDocs to 1.0 2018-08-04 19:53:13 +02:00
setup.py Updated copyright notice 2018-01-13 17:36:13 +01:00
webpack.config.js Added support for web font minification in production 2018-06-18 10:11:54 +02:00

Travis Gitter 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 34 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.