1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-18 02:15:56 +01:00
Documentation that simply works
Go to file
2017-09-01 19:59:48 +07:00
.githooks Removed flaky visual regression tests 2017-05-15 11:05:28 +02:00
.github Added mkdocs.yml as a requirement to issue template 2017-01-22 13:37:46 +01:00
docs Prepare 1.9.0 release 2017-08-29 22:44:46 +07:00
examples Added documentation how to run examples [ci skip] 2017-06-21 10:36:23 +02:00
lib Upgraded dependencies 2017-06-13 15:11:03 +02:00
material Fixed uninitialized overflow scrolling on main pane for iOS 2017-09-01 19:59:48 +07:00
scripts Upgraded dependencies 2017-06-13 15:11:03 +02:00
src Fixed uninitialized overflow scrolling on main pane for iOS 2017-09-01 19:59:48 +07:00
.babelrc Upgraded dependencies and fixed ESLint regression 2017-08-02 12:21:36 +02:00
.editorconfig Update copyright 2017-01-06 19:11:18 +01:00
.eslintignore Removed flaky visual regression tests 2017-05-15 11:05:28 +02:00
.eslintrc Upgraded dependencies 2017-06-13 15:11:03 +02:00
.flowconfig Upgraded dependencies 2017-06-13 15:11:03 +02:00
.gitignore Removed flaky visual regression tests 2017-05-15 11:05:28 +02:00
.stylelintignore Refactored targetted link offsets 2017-04-22 00:42:48 +02:00
.stylelintrc Fixed CSS linting with stylelint 2017-07-25 17:35:17 +02:00
.travis.yml Removed flaky visual regression tests 2017-05-15 11:05:28 +02:00
.travisignore Remove .travisignore from .travisignore 2017-04-08 18:08:12 +02:00
CHANGELOG Fixed uninitialized overflow scrolling on main pane for iOS 2017-09-01 19:59:48 +07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2017-06-21 11:20:50 +02:00
CONTRIBUTING.md Updated link to customization with correct address 2017-04-08 10:37:29 +02:00
Dockerfile Fixed Docker build and added tests 2017-04-16 22:03:53 +02:00
Gulpfile.babel.js Upgraded dependencies 2017-06-13 15:11:03 +02:00
LICENSE Update copyright 2017-01-06 19:11:18 +01:00
MANIFEST.in Fixed missing requirements.txt in package 2017-04-05 11:17:14 +02:00
mkdocs.yml Added basic implementation for details 2017-08-29 13:17:26 +07:00
package.json Prepare 1.9.0 release 2017-08-29 22:44:46 +07:00
README.md Adjusted Docker badge [ci skip] 2017-07-10 11:03:35 +02:00
requirements.txt Refactored Admonition styles 2017-08-26 18:36:49 +07:00
setup.py Added requirements as explicit dependencies in setup.py 2017-03-30 23:39:02 +02:00
yarn.lock Replaced ligatures with Unicode code points 2017-08-29 22:28:53 +07:00

Travis Gitter Codacy Docker PyPI

Material for MkDocs

A Material Design theme for MkDocs.

Material for MkDocs

Quick start

Install with pip:

pip install mkdocs-material

Append the following line to your existing 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.