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 documentation

Browse Source
This commit is contained in:
squidfunk 2020-10-31 17:15:33 +01:00
parent fafe4d2c11
commit c1bf22a638
1 changed files with 36 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/setup/setting-up-the-footer.md
View File

@ -15,7 +15,7 @@ configured via `mkdocs.yml`.
### Social links ### Social links
[:octicons-file-code-24: Source][1] · [:octicons-file-code-24: Source][1] ·
:octicons-milestone-24: Default: _none_ :octicons-milestone-24: Default: _none_
All _social links_ are rendered next to the copyright information as part of the All _social links_ are rendered next to the copyright information as part of the
@ -33,20 +33,20 @@ For each entry, the following fields are available:
`icon`{: #icon } `icon`{: #icon }
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required – : :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required –
This field must point to a valid icon path referencing [any icon bundled This field must point to a valid icon path referencing [any icon bundled
with the theme][2], or the build will not succeed. Some popular choices: with the theme][2], or the build will not succeed. Some popular choices:
* :fontawesome-brands-behance: – `fontawesome/brands/behance` * :fontawesome-brands-behance: – `fontawesome/brands/behance`
* :fontawesome-brands-docker: – `fontawesome/brands/docker` * :fontawesome-brands-docker: – `fontawesome/brands/docker`
* :fontawesome-brands-github: – `fontawesome/brands/github` * :fontawesome-brands-github: – `fontawesome/brands/github`
* :fontawesome-brands-instagram: – `fontawesome/brands/instagram` * :fontawesome-brands-instagram: – `fontawesome/brands/instagram`
* :fontawesome-brands-linkedin: – `fontawesome/brands/linkedin` * :fontawesome-brands-linkedin: – `fontawesome/brands/linkedin`
* :fontawesome-brands-medium: – `fontawesome/brands/medium` * :fontawesome-brands-medium: – `fontawesome/brands/medium`
* :fontawesome-brands-pied-piper-alt: – `fontawesome/brands/pied-piper-alt` * :fontawesome-brands-pied-piper-alt: – `fontawesome/brands/pied-piper-alt`
* :fontawesome-brands-product-hunt: – `fontawesome/brands/product-hunt` * :fontawesome-brands-product-hunt: – `fontawesome/brands/product-hunt`
* :fontawesome-brands-slack: – `fontawesome/brands/slack` * :fontawesome-brands-slack: – `fontawesome/brands/slack`
* :fontawesome-brands-twitter: – `fontawesome/brands/twitter` * :fontawesome-brands-twitter: – `fontawesome/brands/twitter`
[1]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/social.html [1]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/social.html
[2]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons [2]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons
@ -89,12 +89,26 @@ For each entry, the following fields are available:
name: squidfunk on Twitter name: squidfunk on Twitter
``` ```
### Copyright notice
[:octicons-file-code-24: Source][3] ·
:octicons-milestone-24: Default: _none_
A custom _copyright banner_ can be rendered as part of the footer, which is
displayed next to the social links. It can be defined as part of `mkdocs.yml`:
``` yaml
copyright: Copyright © 2016 - 2020 Martin Donath
```
[3]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/footer.html#L85-L99
### Remove generator ### Remove generator
[:octicons-file-code-24: Source][8] · [:octicons-file-code-24: Source][4] ·
[:octicons-heart-fill-24:{: .tx-heart } Insiders only][8]{: .tx-insiders } [:octicons-heart-fill-24:{: .tx-heart } Insiders only][4]{: .tx-insiders }
The footer displays a __Made with Material for MkDocs__ notice to denote how The footer displays a _Made with Material for MkDocs_ notice to denote how
the site was generated. The notice can be removed with the following setting the site was generated. The notice can be removed with the following setting
via `mkdocs.yml`: via `mkdocs.yml`:
@ -103,7 +117,7 @@ extra:
generator: false generator: false
``` ```
[8]: ../insiders.md [4]: ../insiders.md
## Customization ## Customization
@ -112,9 +126,9 @@ extra:
[:octicons-file-code-24: Source][2] · [:octicons-file-code-24: Source][2] ·
:octicons-mortar-board-24: Difficulty: _moderate_ :octicons-mortar-board-24: Difficulty: _moderate_
The social links feature uses the standard [icon integration][3] of Material for The social links feature uses the standard [icon integration][5] of Material for
MkDocs. If you want to use custom icons, follow the guide explaining how to MkDocs. If you want to use custom icons, follow the guide explaining how to
add [additional icons][4]. add [additional icons][6].
[3]: changing-the-logo-and-icons.md#icons [5]: changing-the-logo-and-icons.md#icons
[4]: changing-the-logo-and-icons.md#additional-icons [6]: changing-the-logo-and-icons.md#additional-icons