From c1bf22a638d156df48881011f096c778acd1a59c Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 31 Oct 2020 17:15:33 +0100 Subject: [PATCH] Updated documentation --- docs/setup/setting-up-the-footer.md | 58 ++++++++++++++++++----------- 1 file changed, 36 insertions(+), 22 deletions(-) diff --git a/docs/setup/setting-up-the-footer.md b/docs/setup/setting-up-the-footer.md index 3d7e9f2e6..f14665996 100644 --- a/docs/setup/setting-up-the-footer.md +++ b/docs/setup/setting-up-the-footer.md @@ -15,7 +15,7 @@ configured via `mkdocs.yml`. ### Social links -[:octicons-file-code-24: Source][1] · +[:octicons-file-code-24: Source][1] · :octicons-milestone-24: Default: _none_ 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 } -: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required – - 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: +: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required – + 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: - * :fontawesome-brands-behance: – `fontawesome/brands/behance` - * :fontawesome-brands-docker: – `fontawesome/brands/docker` - * :fontawesome-brands-github: – `fontawesome/brands/github` - * :fontawesome-brands-instagram: – `fontawesome/brands/instagram` - * :fontawesome-brands-linkedin: – `fontawesome/brands/linkedin` - * :fontawesome-brands-medium: – `fontawesome/brands/medium` - * :fontawesome-brands-pied-piper-alt: – `fontawesome/brands/pied-piper-alt` - * :fontawesome-brands-product-hunt: – `fontawesome/brands/product-hunt` - * :fontawesome-brands-slack: – `fontawesome/brands/slack` - * :fontawesome-brands-twitter: – `fontawesome/brands/twitter` + * :fontawesome-brands-behance: – `fontawesome/brands/behance` + * :fontawesome-brands-docker: – `fontawesome/brands/docker` + * :fontawesome-brands-github: – `fontawesome/brands/github` + * :fontawesome-brands-instagram: – `fontawesome/brands/instagram` + * :fontawesome-brands-linkedin: – `fontawesome/brands/linkedin` + * :fontawesome-brands-medium: – `fontawesome/brands/medium` + * :fontawesome-brands-pied-piper-alt: – `fontawesome/brands/pied-piper-alt` + * :fontawesome-brands-product-hunt: – `fontawesome/brands/product-hunt` + * :fontawesome-brands-slack: – `fontawesome/brands/slack` + * :fontawesome-brands-twitter: – `fontawesome/brands/twitter` [1]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/social.html [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 ``` +### 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 -[:octicons-file-code-24: Source][8] · -[:octicons-heart-fill-24:{: .tx-heart } Insiders only][8]{: .tx-insiders } +[:octicons-file-code-24: Source][4] · +[: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 via `mkdocs.yml`: @@ -103,7 +117,7 @@ extra: generator: false ``` - [8]: ../insiders.md + [4]: ../insiders.md ## Customization @@ -112,9 +126,9 @@ extra: [:octicons-file-code-24: Source][2] · :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 -add [additional icons][4]. +add [additional icons][6]. - [3]: changing-the-logo-and-icons.md#icons - [4]: changing-the-logo-and-icons.md#additional-icons + [5]: changing-the-logo-and-icons.md#icons + [6]: changing-the-logo-and-icons.md#additional-icons