1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-12 01:50:52 +01:00
Documentation that simply works
Go to file
2017-01-04 20:16:12 +01:00
.githooks Refactored githook for pre-commit linting 2016-12-27 10:32:02 +01:00
.github Implemented basic search modal functionality 2016-10-23 10:21:37 +02:00
docs Fixed #79: Modularized social links integration 2017-01-04 20:16:12 +01:00
lib Remove unfinished test infrastructure until after release 2017-01-02 23:18:44 +01:00
material Fixed #79: Modularized social links integration 2017-01-04 20:16:12 +01:00
scripts Replaced SASS Lint with Stylelint 2017-01-01 15:59:44 +01:00
src Fixed #79: Modularized social links integration 2017-01-04 20:16:12 +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
.stylelintrc Replaced SASS Lint with Stylelint 2017-01-01 15:59:44 +01:00
.travis.yml Test caching in Travis 2016-12-31 18:05:31 +01:00
CHANGELOG Replaced SASS Lint with Stylelint 2017-01-01 15:59:44 +01:00
CONTRIBUTING.md Correct typo in contribution guidelines [ci skip] 2016-12-29 19:06:47 +01:00
Gulpfile.babel.js Remove unfinished test infrastructure until after release 2017-01-02 23:18:44 +01:00
LICENSE Package theme for submission to PyPI 2016-02-04 15:03:20 +01:00
MANIFEST.in Make theme installable 2017-01-02 08:58:18 +01:00
mkdocs.yml Fixed #79: Modularized social links integration 2017-01-04 20:16:12 +01:00
package.json Merged master into rework 2017-01-02 23:22:16 +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 Set required mkdocs version to >= 0.16 2016-12-27 10:19:35 +01:00
setup.py Make theme installable 2017-01-02 08:58:18 +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.