OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated customization guide

Browse Source
This commit is contained in:
squidfunk 2021-04-10 11:13:32 +02:00
parent fd856ed712
commit 64de0fd626
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/customization.md
View File

@ -178,7 +178,7 @@ Then, e.g. to override the site title, add the following line to `main.html`:
Material for MkDocs provides the following template blocks:
| Block name | Wrapped contents |
| Block name | Purpose |
|:------------------|:------------------------------------------------|
| `analytics` | Wraps the Google Analytics integration |
| `announce` | Wraps the announcement bar |
@ -204,16 +204,27 @@ For more on this topic refer to the [MkDocs documentation][5].
[5]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks
Material for MkDocs provides also extra variables that can be set in `main.html`, e.g.
#### Additional variables
Besides template blocks, Material for MkDocs provides extra variables for parts
that cannot be overridden with template blocks (due to technical limitations of
the template engine). If you want to add further information after the _Made
with Material for MkDocs_ hint in the footer, add the following line to
`main.html`:
``` html
{% extends "base.html" %}
{% set extracopyright %}
an this other tool
<!-- Add your additional information here -->
{% endset %}
```
will add `an this other tool` next to the `Made with Material for Mkdocs` in the footer.
Material for MkDocs provides the following additional variables:
| Block name | Purpose |
|:------------------|:------------------------------------------------|
| `extracopyright` | Adds custom copyright information |
## Theme development