diff --git a/MANIFEST.in b/MANIFEST.in index 770a07a045131d2a520f3655ee90533c2fe30fdb..83ee74c85378d4a7e2297636f95cdd86935ec50a 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 1cf3bcaf6f2a31992fb1e05d8733930ece2262db..cab56eef00ebbdb55f3c9ff123a8fbf4e348a1c1 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. + + + +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 699f11e3086e21856554dafe64c8611e2941e437..039e7b6768e196c3295e1a86116a9f8c2e48cd56 100644 --- a/material/base.html +++ b/material/base.html @@ -25,6 +25,9 @@ <meta name="author" content="{{ site_author }}"> {% endif %} {% endblock %} + <meta property="og:url" content="{{ canonical_url }}"> + <meta property="og:title" content="{{ site_name }}"> + <meta property="og:image" content="{{ canonical_url }}/{{ base_url }}/{{ config.extra.logo }}"> <meta name="apple-mobile-web-app-title" content="{{ site_name }}"> <meta name="apple-mobile-web-app-capable" content="yes"> <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"> diff --git a/setup.py b/setup.py index f5d98afe8052a1a1a868465bd0a55283a08dea97..adc326c1217f12965d34b7432121c374bd2c7a47 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 26c7d76dd2316713383b77d8d36e6729be20424d..a9a92c84a99a53752fdc42bc43d319923d080499 100644 --- a/src/base.html +++ b/src/base.html @@ -39,6 +39,12 @@ {% endif %} {% endblock %} + <!-- Open graph tags --> + <meta property="og:url" content="{{ canonical_url }}" /> + <meta property="og:title" content="{{ site_name }}"/> + <meta property="og:image" + content="{{ canonical_url }}/{{ base_url }}/{{ config.extra.logo }}" /> + <!-- Web application capability on iOS --> <meta name="apple-mobile-web-app-title" content="{{ site_name }}" /> <meta name="apple-mobile-web-app-capable" content="yes" />