1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-09-24 11:28:23 +02:00
Documentation that simply works
Go to file
2016-11-01 20:30:28 +01:00
.githooks Moved scripts into bin 2016-10-30 19:30:55 +01:00
.github Implemented basic search modal functionality 2016-10-23 10:21:37 +02:00
bin Make paths in bin absolute 2016-11-01 20:30:28 +01:00
docs Removed unnecessary docs 2016-10-30 11:28:21 +01:00
lib Fix linter errors and warnings 2016-10-31 09:58:43 +01:00
material Finished full integration for CodeHilite 2016-10-30 10:36:18 +01:00
src Finished footnotes integration 2016-10-30 11:02:18 +01:00
tests Added full JSX support to build pipeline 2016-10-10 12:35:25 +02:00
.babelrc Implemented basic search modal functionality 2016-10-23 10:21:37 +02:00
.editorconfig Added editor configuration 2016-10-07 11:17:00 +02:00
.eslintignore Fix linter errors and warnings 2016-10-31 09:58:43 +01:00
.eslintrc Fix linter errors and warnings 2016-10-31 09:58:43 +01:00
.gitignore Integrated karma for unit tests 2016-10-07 16:38:13 +02:00
.sass-lint.yml Finished full integration for CodeHilite 2016-10-30 10:36:18 +01:00
.travis.yml Fix wrong path in scripts + try user-level install for pip 2016-10-31 10:16:26 +01:00
CHANGELOG Updated changelog 2016-10-06 19:26:49 +02:00
Gulpfile.babel.js Added missing return into task load helper 2016-10-31 17:10:31 +01:00
LICENSE Package theme for submission to PyPI 2016-02-04 15:03:20 +01:00
MANIFEST.in Rewrite of Gulp asset pipeline in ES6 and separation of tasks 2016-10-06 12:14:33 +02:00
mkdocs.yml Forgot to update mkdocs.yml [ci skip] 2016-10-30 11:29:24 +01:00
package.json Moved scripts into bin 2016-10-30 19:30:55 +01:00
README.md Update documentation for installation 2016-10-12 17:45:44 +10:00
requirements.txt Added mkdocs to requirements.txt 2016-10-31 09:32:05 +01:00
setup.py Prepare 0.2.1 release 2016-03-12 13:25:05 +01:00

Material

Travis CI PyPI Downloads PyPI Version

A material design theme for MkDocs.

iOS

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