mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Aaaaand we're good
This commit is contained in:
parent
ac54535487
commit
869687b5df
@ -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]
|
28
README.md
28
README.md
@ -1 +1,27 @@
|
||||
A material design theme for MkDocs
|
||||
# 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
|
@ -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">
|
||||
|
1
setup.py
1
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 = {
|
||||
|
@ -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" />
|
||||
|
Loading…
Reference in New Issue
Block a user