squidfunk
/
mkdocs-material
mirror of https://github.com/squidfunk/mkdocs-material.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated README and landing page

This commit is contained in:
squidfunk 2017-01-12 22:39:18 +01:00
parent 23be61a803
commit 57d2a4e4a5
3 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,14 +1,8 @@
# Material
[![Travis][travis-image]][travis-link] [![Travis][travis-image]][travis-link]
[![Dependencies][deps-image]][deps-link] [![Dependencies][deps-image]][deps-link]
[![Codacy][codacy-image]][codacy-link] [![Codacy][codacy-image]][codacy-link]
[![PyPI][pypi-image]][pypi-link] [![PyPI][pypi-image]][pypi-link]
A Material Design theme for [MkDocs](http://www.mkdocs.org).
TBD: [![_](docs/images/material.png)](http://squidfunk.github.io/mkdocs-material/)
[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
[deps-image]: https://david-dm.org/squidfunk/mkdocs-material/dev-status.svg [deps-image]: https://david-dm.org/squidfunk/mkdocs-material/dev-status.svg
@ -18,6 +12,12 @@ TBD: [![_](docs/images/material.png)](http://squidfunk.github.io/mkdocs-material
[pypi-image]: https://img.shields.io/pypi/v/mkdocs-material.svg [pypi-image]: https://img.shields.io/pypi/v/mkdocs-material.svg
[pypi-link]: https://pypi.python.org/pypi/mkdocs-material [pypi-link]: https://pypi.python.org/pypi/mkdocs-material
# Material for MkDocs
A Material Design theme for [MkDocs](http://www.mkdocs.org).
[![Material for MkDocs](docs/images/material.png)](docs/images/material.png)
## Quick start ## Quick start
Install with `pip`: Install with `pip`:

BIN
docs/images/material.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 757 KiB

2
docs/index.md
View File

@ -6,6 +6,8 @@ Material is a theme for [MkDocs][1], an excellent static site generator geared
towards project documentation. It is built using Google's [Material Design][2] towards project documentation. It is built using Google's [Material Design][2]
guidelines. guidelines.
[![Material for MkDocs](images/material.png)](images/material.png)
[1]: http://www.mkdocs.org [1]: http://www.mkdocs.org
[2]: https://www.google.com/design/spec/material-design [2]: https://www.google.com/design/spec/material-design