设置页脚

您的项目文档的页脚是添加到网站或平台链接的好地方，这些链接是您或您的公司作为额外的营销渠道使用的，例如 Mastodon 或 YouTube，您可以通过mkdocs.yml轻松配置。

配置

导航

页脚可以包含到当前页面的上一页和下一页的链接。如果您希望启用此行为，请将以下行添加到mkdocs.yml：

theme:
  features:
    - navigation.footer

社交链接

社交链接作为项目文档页脚的一部分，与版权通知一起呈现。在mkdocs.yml中添加一个社交链接列表：

extra:
  social:
    - icon: fontawesome/brands/mastodon # (1)!
      link: https://fosstodon.org/@squidfunk

1. 输入几个关键词，使用我们的图标搜索功能找到完美的图标，并点击短代码将其复制到您的剪贴板：

每个链接都有以下属性可用：

icon

默认：none · 必填项 – 此属性必须包含指向与主题捆绑的任何图标的有效路径， 否则构建将不会成功。一些流行的选择包括：

* Mastodon – `fontawesome/brands/mastodon`
  <small>自动添加 `rel=me`</small>
* Twitter – `fontawesome/brands/twitter`
* Github – `fontawesome/brands/github`
* Docker – `fontawesome/brands/docker`
* Facebook – `fontawesome/brands/facebook`
* Medium – `fontawesome/brands/medium`
* Instagram – `fontawesome/brands/instagram`
* Linkedin – `fontawesome/brands/linkedin`
* Pied Piper Alt – `fontawesome/brands/pied-piper-alt`
* Slack – `fontawesome/brands/slack`
* Discord – `fontawesome/brands/discord`

link

默认：none · 必填项 – 此属性必须设置为包含 URI 方案的相对或绝对 URL。所有 URI 方案都受支持，包括mailto和bitcoin：

!!! info "Mastodon"

    ``` yaml
    extra:
      social:
        - icon: fontawesome/brands/mastodon
          link: https://fosstodon.org/@squidfunk
    ```

!!! info "Email"

    ``` yaml
    extra:
      social:
        - icon: fontawesome/solid/paper-plane
          link: mailto:<email-address>
    ```

name

默认：link的域名（如果可用） – 此属性用作链接的title属性，可以设置为一个可识别的名称以提高可访问性：

``` yaml
extra:
  social:
    - icon: fontawesome/brands/mastodon
      link: https://fosstodon.org/@squidfunk
      name: squidfunk on Fosstodon
```

版权通知

可以作为页脚的一部分呈现一个自定义的版权横幅，它显示在社交链接旁边。它可以作为mkdocs.yml的一部分定义：

copyright: Copyright © 2016 - 2020 Martin Donath

生成器通知

页脚显示一个 Made with Material for MkDocs 通知，以表示该站点是如何生成的。可以通过mkdocs.yml的以下选项删除通知：

extra:
  generator: false

在删除生成器通知之前，请阅读这个

页脚中细微的 Made with Material for MkDocs 提示是这个项目如此受欢迎的原因之一，因为它告诉用户该网站是如何生成的，帮助新用户发现这个项目。在删除之前，请考虑你正在免费享受@squidfunk的工作成果，因为这个项目是开源的，并有一个许可的许可证。数千小时投入到这个项目中，其中大部分没有任何经济回报。

因此，如果你删除这个通知，请考虑赞助这个项目。 谢谢你

使用

隐藏上一页/下一页链接

页脚导航显示链接到上一页和下一页的链接可以通过前置hide属性隐藏。在 Markdown 文件的顶部添加以下行：

---
hide:
  - footer
---
# Document title

自定义

自定义版权

为了自定义和覆盖版权通知，扩展主题并覆盖copyright.html部分，该部分通常包括在mkdocs.yml中设置的copyright属性。