Skip to content
Snippets Groups Projects
Commit 869687b5 authored by squidfunk's avatar squidfunk
Browse files

Aaaaand we're good

parent ac545354
No related branches found
No related tags found
No related merge requests found
recursive-include material *.ico *.js *.css *.html *.eot *.svg *.ttf *.woff
recursive-exclude site *
\ No newline at end of file
recursive-exclude * __pycache__
recursive-exclude * *.py[co]
\ No newline at end of file
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
......@@ -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">
......
......@@ -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 = {
......
......@@ -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" />
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment