Skip to content

Commit 869687b

Browse files
committed
Aaaaand we're good
1 parent ac54535 commit 869687b

File tree

5 files changed

+38
-4
lines changed

5 files changed

+38
-4
lines changed

MANIFEST.in

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
recursive-include material *.ico *.js *.css *.html *.eot *.svg *.ttf *.woff
2-
recursive-exclude site *
3-
recursive-exclude * __pycache__
4-
recursive-exclude * *.py[co]
2+
recursive-exclude site *

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
A material design theme for MkDocs
1+
# Material
2+
3+
[![PyPI Downloads][pypi-dl-image]][pypi-dl-link]
4+
[![PyPI Version][pypi-v-image]][pypi-v-link]
5+
6+
A material design theme for MkDocs.
7+
8+
![iOS](docs/images/screen.png)
9+
10+
Install with `pip`:
11+
12+
``` sh
13+
pip install mkdocs-material
14+
```
15+
16+
Add the following line to your `mkdocs.yml`:
17+
18+
``` yaml
19+
theme: 'material'
20+
```
21+
22+
For detailed installation instructions and a demo, visit [squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/)
23+
24+
[pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png
25+
[pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material
26+
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png
27+
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material

material/base.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
<meta name="author" content="{{ site_author }}">
2626
{% endif %}
2727
{% endblock %}
28+
<meta property="og:url" content="{{ canonical_url }}">
29+
<meta property="og:title" content="{{ site_name }}">
30+
<meta property="og:image" content="{{ canonical_url }}/{{ base_url }}/{{ config.extra.logo }}">
2831
<meta name="apple-mobile-web-app-title" content="{{ site_name }}">
2932
<meta name="apple-mobile-web-app-capable" content="yes">
3033
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
description = 'A material design theme for MkDocs',
3030
author = 'Martin Donath',
3131
author_email = 'martin.donath@squidfunk.com',
32+
keywords = ['mkdocs', 'documentation', 'theme'],
3233
packages = find_packages(),
3334
include_package_data = True,
3435
entry_points = {

src/base.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@
3939
{% endif %}
4040
{% endblock %}
4141

42+
<!-- Open graph tags -->
43+
<meta property="og:url" content="{{ canonical_url }}" />
44+
<meta property="og:title" content="{{ site_name }}"/>
45+
<meta property="og:image"
46+
content="{{ canonical_url }}/{{ base_url }}/{{ config.extra.logo }}" />
47+
4248
<!-- Web application capability on iOS -->
4349
<meta name="apple-mobile-web-app-title" content="{{ site_name }}" />
4450
<meta name="apple-mobile-web-app-capable" content="yes" />

0 commit comments

Comments
 (0)