Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-09-24 11:28:23 +02:00
Code Issues Releases Wiki Activity
Documentation that simply works
77 Commits 2 Branches 403 Tags 405 MiB
HTML 31.1%
TypeScript 27.1%
Python 25.3%
SCSS 15.7%
CSS 0.6%
Other 0.2%
d5ddc1ab8f
Go to file
squidfunk d5ddc1ab8f Added npm-debug.log to .gitignore
2016-10-06 15:16:57 +02:00
.githooks/pre-commit Introduced pre-commit hook for linting 2016-10-06 15:14:03 +02:00
docs Refactored navigation and drawer 2016-09-23 11:56:25 +02:00
material Rewrite of Gulp asset pipeline in ES6 and separation of tasks 2016-10-06 12:14:33 +02:00
src Rewrite of Gulp asset pipeline in ES6 and separation of tasks 2016-10-06 12:14:33 +02:00
tasks Rewrite of Gulp asset pipeline in ES6 and separation of tasks 2016-10-06 12:14:33 +02:00
.babelrc Rewrite of Gulp asset pipeline in ES6 and separation of tasks 2016-10-06 12:14:33 +02:00
.eslintrc Rewrite of Gulp asset pipeline in ES6 and separation of tasks 2016-10-06 12:14:33 +02:00
.gitignore Added npm-debug.log to .gitignore 2016-10-06 15:16:57 +02:00
.nvmrc Rewrite of Gulp asset pipeline in ES6 and separation of tasks 2016-10-06 12:14:33 +02:00
.sass-lint.yml Rewrite of Gulp asset pipeline in ES6 and separation of tasks 2016-10-06 12:14:33 +02:00
.travis.yml Rewrite of Gulp asset pipeline in ES6 and separation of tasks 2016-10-06 12:14:33 +02:00
CHANGELOG Introduced pre-commit hook for linting 2016-10-06 15:14:03 +02:00
Gulpfile.babel.js Introduced pre-commit hook for linting 2016-10-06 15:14:03 +02: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 Refactored navigation and drawer 2016-09-23 11:56:25 +02:00
package.json Introduced pre-commit hook for linting 2016-10-06 15:14:03 +02:00
README.md Updated documentation 2016-02-17 18:08:11 +01:00
setup.py Prepare 0.2.1 release 2016-03-12 13:25:05 +01:00

README.md

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.