Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-12 01:50:52 +01:00
Code Issues Releases Wiki Activity
Documentation that simply works
62 Commits 2 Branches 411 Tags 416 MiB
HTML 31.2%
TypeScript 27.1%
Python 25.2%
SCSS 15.7%
CSS 0.6%
Other 0.2%
2784a4f781
Go to file
squidfunk 2784a4f781 Fixed #33: Protocol relative URL for webfonts doesn't work with file://
2016-06-26 13:50:24 +02:00
docs Fixed #15: Document pygments dependency for codehilite 2016-03-17 17:15:11 +01:00
material Fixed #33: Protocol relative URL for webfonts doesn't work with file:// 2016-06-26 13:50:24 +02:00
src Fixed #33: Protocol relative URL for webfonts doesn't work with file:// 2016-06-26 13:50:24 +02:00
.gitignore Preparing release 2016-02-09 12:58:55 +01:00
.travis.yml Fixed typo in bower.json 2016-02-11 12:14:27 +01:00
bower.json Prepare 0.2.3 release 2016-05-16 16:48:11 +02:00
CHANGELOG Fixed #33: Protocol relative URL for webfonts doesn't work with file:// 2016-06-26 13:50:24 +02:00
Gulpfile.js Corrected wrong path for static asset monitoring in Gulpfile 2016-02-27 12:19:18 +01:00
LICENSE Package theme for submission to PyPI 2016-02-04 15:03:20 +01:00
MANIFEST.in Aaaaand we're good 2016-02-09 23:48:01 +01:00
mkdocs.yml Prepare 0.2.3 release 2016-05-16 16:48:11 +02:00
package.json Prepare 0.2.3 release 2016-05-16 16:48:11 +02:00
README.md Updated documentation 2016-02-17 18:08:11 +01:00
setup.py Prepare 0.2.3 release 2016-05-16 16:48:11 +02: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.