1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-14 10:57:41 +01:00
Documentation that simply works
Go to file
2017-02-10 16:43:32 +01:00
.githooks Remove ... on hooks 2017-01-18 23:26:22 +01:00
.github Added mkdocs.yml as a requirement to issue template 2017-01-22 13:37:46 +01:00
docs Prepare 1.0.3 release 2017-01-22 13:42:44 +01:00
lib Enable HTML report in Travis build 2017-02-10 15:06:23 +01:00
material Removed webfonts for visual tests 2017-02-10 16:43:32 +01:00
scripts Travis must build non-optimized assets due to pseudo classes 2017-02-10 10:50:34 +01:00
src Removed webfonts for visual tests 2017-02-10 16:43:32 +01:00
tests/visual Removed webfonts for visual tests 2017-02-10 16:43:32 +01:00
.babelrc Implemented basic search modal functionality 2016-10-23 10:21:37 +02:00
.editorconfig Update copyright 2017-01-06 19:11:18 +01:00
.eslintignore Implemented Gemini screenshot testing base 2017-01-28 20:25:30 +01:00
.eslintrc Refactored JavaScript architecture 2016-12-15 15:55:40 +01:00
.gitignore Added tests for navigation and improved test generation logic 2017-02-01 23:56:57 +01:00
.stylelintrc Fixed stylelint deprecations 2017-02-05 23:51:32 +01:00
.travis.yml Disable artifacts debug 2017-02-10 16:01:38 +01:00
CHANGELOG Prepare 1.0.3 release 2017-01-22 13:42:44 +01:00
CONTRIBUTING.md Update contribution guidelines for GitHub 2017-01-07 20:08:49 +01:00
Dockerfile Updated Dockerfile and added documentation 2017-01-14 19:24:07 +01:00
Gulpfile.babel.js Disable artifacts debug 2017-02-10 16:01:38 +01:00
LICENSE Update copyright 2017-01-06 19:11:18 +01:00
MANIFEST.in Make theme installable 2017-01-02 08:58:18 +01:00
mkdocs.yml Remove ... on hooks 2017-01-18 23:26:22 +01:00
package.json Try to speed up build 2017-02-09 18:07:11 +01:00
README.md Updated Dockerfile and added documentation 2017-01-14 19:24:07 +01:00
requirements.txt Set PyMdown requirement to 1.2 2017-01-28 20:32:13 +01:00
setup.py Load package specs in setup.py from package.json 2017-01-14 23:05:18 +01:00
yarn.lock Fixed stylelint deprecations 2017-02-05 23:51:32 +01:00

Travis Dependencies Codacy Docker PyPI

Material for MkDocs

A Material Design theme for MkDocs.

Material for MkDocs

Quick start

Install with pip:

pip install mkdocs-material

Add the following line to your mkdocs.yml:

theme: 'material'

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

License

MIT License

Copyright (c) 2016-2017 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.