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
2017-01-12 20:54:20 +01:00
.githooks Prevent pre-commit hook from triggering on JSON 2017-01-12 20:20:56 +01:00
.github Implemented basic search modal functionality 2016-10-23 10:21:37 +02:00
docs Updated documentation 2017-01-12 20:15:30 +01:00
lib Update copyright 2017-01-06 19:11:18 +01:00
material Updated dependencies to latest stable releases 2017-01-12 20:54:20 +01:00
scripts Update copyright 2017-01-06 19:11:18 +01:00
src Remove icon ligatures from HTML to fix search indexing 2017-01-11 23:49:36 +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 Adjusted ignored files for ESLint 2017-01-09 20:33:25 +01:00
.eslintrc Refactored JavaScript architecture 2016-12-15 15:55:40 +01:00
.gitignore Updated documentation 2017-01-12 20:15:30 +01:00
.stylelintrc Replaced SASS Lint with Stylelint 2017-01-01 15:59:44 +01:00
.travis.yml Update copyright 2017-01-06 19:11:18 +01:00
CHANGELOG Updated documentation 2017-01-12 20:15:30 +01:00
CONTRIBUTING.md Update contribution guidelines for GitHub 2017-01-07 20:08:49 +01:00
Gulpfile.babel.js Update copyright 2017-01-06 19:11:18 +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 Updated documentation 2017-01-12 20:15:30 +01:00
package.json Updated dependencies to latest stable releases 2017-01-12 20:54:20 +01:00
README.md Updated documentation 2017-01-12 20:15:30 +01:00
requirements.txt Update copyright 2017-01-06 19:11:18 +01:00
setup.py Updated documentation 2017-01-12 20:15:30 +01:00

Material

Travis Codacy PyPI

A Material Design theme for MkDocs.

TBD: _

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.