OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity
80 Commits 2 Branches 393 Tags 155 MiB
HTML 31.1%
TypeScript 27.1%
Python 25.3%
SCSS 15.7%
CSS 0.6%
Other 0.2%
59605d0e0c
Go to file
greenkeeper[bot] 59605d0e0c chore(package): update gulp-sourcemaps to version 2.2.2 
https://greenkeeper.io/
2017-01-08 19:30:44 +00:00
.github Added issue template for GitHub 2016-10-10 09:43:30 +02:00
docs Allow translating search bar placeholder 2016-11-05 13:59:47 +01:00
material Allow translating search bar placeholder 2016-11-05 13:59:47 +01:00
src Allow translating search bar placeholder 2016-11-05 13:59:47 +01: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 Fixed #44: Invalid left-hand side in assignment 2016-09-18 15:19:08 +02:00
CHANGELOG Prepare 0.2.4 release 2016-06-26 14:16:59 +02:00
CONTRIBUTING.md Correct typo in contribution guidelines [ci skip] 2016-12-29 19:06:47 +01: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 Add option to link to GitHub release. 2016-06-29 18:18:12 +02:00
package.json chore(package): update gulp-sourcemaps to version 2.2.2 2017-01-08 19:30:44 +00:00
README.md Update README.md 2016-09-30 13:37:21 +02:00
setup.py Prepare 0.2.4 release 2016-06-26 14:16:59 +02:00

README.md

Material

Travis CI PyPI Version

A material design theme for MkDocs.

Note: the theme is currently undergoing a complete rewrite for 1.0.0 which should be released shortly.

  • To get a glimpse, checkout the rework branch
  • To give feedback on the rework version, please see issues #46

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.