diff --git a/MANIFEST.in b/MANIFEST.in index 770a07a04..83ee74c85 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,2 @@ recursive-include material *.ico *.js *.css *.html *.eot *.svg *.ttf *.woff -recursive-exclude site * -recursive-exclude * __pycache__ -recursive-exclude * *.py[co] \ No newline at end of file +recursive-exclude site * \ No newline at end of file diff --git a/README.md b/README.md index 1cf3bcaf6..cab56eef0 100644 --- a/README.md +++ b/README.md @@ -1 +1,27 @@ -A material design theme for MkDocs \ No newline at end of file +# Material + +[![PyPI Downloads][pypi-dl-image]][pypi-dl-link] +[![PyPI Version][pypi-v-image]][pypi-v-link] + +A material design theme for MkDocs. + +![iOS](docs/images/screen.png) + +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 [squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/) + +[pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png +[pypi-dl-link]: https://pypi.python.org/pypi/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 diff --git a/material/base.html b/material/base.html index 699f11e30..039e7b676 100644 --- a/material/base.html +++ b/material/base.html @@ -25,6 +25,9 @@ {% endif %} {% endblock %} + + + diff --git a/setup.py b/setup.py index f5d98afe8..adc326c12 100644 --- a/setup.py +++ b/setup.py @@ -29,6 +29,7 @@ setup( description = 'A material design theme for MkDocs', author = 'Martin Donath', author_email = 'martin.donath@squidfunk.com', + keywords = ['mkdocs', 'documentation', 'theme'], packages = find_packages(), include_package_data = True, entry_points = { diff --git a/src/base.html b/src/base.html index 26c7d76dd..a9a92c84a 100644 --- a/src/base.html +++ b/src/base.html @@ -39,6 +39,12 @@ {% endif %} {% endblock %} + + + + +