1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-09-24 03:18:21 +02:00
Documentation that simply works
Go to file
2016-12-26 14:54:10 +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
docs Added pandoc table styles to specimen 2016-12-18 14:02:20 +01:00
lib Refactored JavaScript architecture 2016-12-15 15:55:40 +01:00
material Unify access via data attributes 2016-12-26 14:47:50 +01:00
scripts Rename bin to scripts to avoid confusion 2016-12-17 13:04:57 +01:00
src Correct footer padding so that it matches header padding 2016-12-26 14:54:10 +01:00
tests Refactored JavaScript into components 2016-11-02 19:21:14 +01: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 Refactored JavaScript architecture 2016-12-15 15:55:40 +01:00
.gitignore Integrated karma for unit tests 2016-10-07 16:38:13 +02:00
.sass-lint.yml Refactored JavaScript architecture 2016-12-15 15:55:40 +01:00
.travis.yml Remove gcc/g++ dependency from CI build 2016-12-15 20:12:45 +01:00
CHANGELOG Prepare 1.0.0-beta release 2016-12-18 19:42:08 +01:00
Gulpfile.babel.js Refactored JavaScript architecture 2016-12-15 15:55:40 +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 Integrated palettes from 0.2.x 2016-12-17 12:53:24 +01:00
package.json Prepare 1.0.0-beta release 2016-12-18 19:42:08 +01:00
README.md Merge pull request #65 from brendo:issue-63-mkdocs-016-compatible 2016-12-15 16:43:40 +01:00
requirements.txt Added mkdocs to requirements.txt 2016-10-31 09:32:05 +01:00
setup.py Prepare 1.0.0-beta release 2016-12-18 19:42:08 +01:00

Material

Travis CI PyPI Downloads PyPI Version

A material design theme for MkDocs 0.16.

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.