From b1900d6ebcc39738885f90fa9f18b28206a74947 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Sun, 24 Jul 2016 19:13:40 -0400 Subject: very early checkin of template for user-docs, only a few pages filled out --- mkdocs-material/README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 mkdocs-material/README.md (limited to 'mkdocs-material/README.md') diff --git a/mkdocs-material/README.md b/mkdocs-material/README.md new file mode 100644 index 00000000..bf4cd563 --- /dev/null +++ b/mkdocs-material/README.md @@ -0,0 +1,54 @@ +# Material + +[![Travis CI][travis-image]][travis-link] +[![PyPI Version][pypi-v-image]][pypi-v-link] + +A material design theme for [MkDocs](http://www.mkdocs.org). + +[![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/) + +## Quick start + +Install with `pip`: + +``` sh +pip install mkdocs-material +``` + +Add the following line to your `mkdocs.yml`: + +``` yaml +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. + +[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg +[travis-link]: https://travis-ci.org/squidfunk/mkdocs-material +[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png +[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material \ No newline at end of file -- cgit v1.3.1