设置页脚¶

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

配置¶

导航¶

9.0.0

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

theme:
  features:
    - navigation.footer

社交链接¶

1.0.0

社交链接作为项目文档页脚的一部分，在版权声明旁边呈现。在 mkdocs.yml 中添加社交链接列表：

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

1. 输入几个关键词以查找完美的图标，使用我们的 icon search 并点击短代码将其复制到剪贴板：

以下属性可用于每个链接：

icon

此属性必须包含主题中捆绑的任何图标的有效路径，否则构建将无法成功。一些流行的选择：

• – fontawesome/brands/github
• – fontawesome/brands/gitlab
• – fontawesome/brands/x-twitter
• – fontawesome/brands/mastodon 自动添加 rel=me
• – fontawesome/brands/docker
• – fontawesome/brands/facebook
• – fontawesome/brands/instagram
• – fontawesome/brands/linkedin
• – fontawesome/brands/slack
• – fontawesome/brands/discord
• – fontawesome/brands/pied-piper-alt

link

此属性必须设置为包含 URI 方案的相对或绝对 URL。所有 URI 方案均受支持，包括 mailto 和 bitcoin：

Mastodon Email

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

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

name

domain name from link, if available 此属性用作链接的 title 属性，可以设置为可识别的名称以提高可访问性：

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

版权声明¶

0.1.0

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

copyright: Copyright © 2016 - 2020 Martin Donath

生成器声明¶

7.3.0 true

页脚显示 使用 Material for MkDocs 制作 的声明，以表示网站的生成方式。可以通过 mkdocs.yml 中的以下选项删除该声明：

extra:
  generator: false

使用¶

隐藏上一页/下一页链接¶

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

---
hide:
  - footer
---

# 页面标题
...

自定义¶

自定义版权¶

8.0.0

为了自定义和覆盖 版权声明，扩展主题 和 [覆盖 copyright.html 部分][overriding partials]，通常包括在 mkdocs.yml 中设置的 copyright 属性。