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

Update README.md

Browse Source
This commit is contained in:
Martin Donath 2016-09-20 09:27:42 +02:00 committed by GitHub
parent 854fed7fb9
commit e21949edc5
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -5,6 +5,13 @@
A material design theme for [MkDocs](http://www.mkdocs.org). A material design theme for [MkDocs](http://www.mkdocs.org).
**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](https://github.com/squidfunk/mkdocs-material/tree/rework) branch
* To give feedback on the rework version, please see issues [#46](https://github.com/squidfunk/mkdocs-material/issues/46)
[![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/) [![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/)
## Quick start ## Quick start
@ -51,4 +58,4 @@ IN THE SOFTWARE.
[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg [travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg
[travis-link]: https://travis-ci.org/squidfunk/mkdocs-material [travis-link]: https://travis-ci.org/squidfunk/mkdocs-material
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png [pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material [pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material