Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
mkdocs-material
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
Janne Mareike Koschinski
mkdocs-material
Commits
869687b5
Commit
869687b5
authored
9 years ago
by
squidfunk
Browse files
Options
Downloads
Patches
Plain Diff
Aaaaand we're good
parent
ac545354
No related branches found
No related tags found
No related merge requests found
Changes
5
Show whitespace changes
Inline
Side-by-side
Showing
5 changed files
MANIFEST.in
+1
-3
1 addition, 3 deletions
MANIFEST.in
README.md
+27
-1
27 additions, 1 deletion
README.md
material/base.html
+3
-0
3 additions, 0 deletions
material/base.html
setup.py
+1
-0
1 addition, 0 deletions
setup.py
src/base.html
+6
-0
6 additions, 0 deletions
src/base.html
with
38 additions
and
4 deletions
MANIFEST.in
+
1
−
3
View file @
869687b5
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
This diff is collapsed.
Click to expand it.
README.md
+
27
−
1
View file @
869687b5
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
This diff is collapsed.
Click to expand it.
material/base.html
+
3
−
0
View file @
869687b5
...
...
@@ -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"
>
...
...
This diff is collapsed.
Click to expand it.
setup.py
+
1
−
0
View file @
869687b5
...
...
@@ -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
=
{
...
...
This diff is collapsed.
Click to expand it.
src/base.html
+
6
−
0
View file @
869687b5
...
...
@@ -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"
/>
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment