跳转至

设置页脚

项目文档的页脚是添加指向您或您的公司用作额外营销渠道的网站或平台的链接的好地方,您可以通过 mkdocs.yml 轻松配置。

配置

导航

页脚可以包含指向当前页面的上一页和下一页的链接。如果要启用此行为,请将以下行添加到 mkdocs.yml:

theme:
  features:
    - navigation.footer

社交链接

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

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

用法

隐藏 prev/next 链接

显示指向上一页和下一页的链接的页脚导航可以使用扉页 hide 属性隐藏。在 Markdown 文件的顶部添加以下行:

---
hide:
  - footer
---

# Page title
...

自定义

自定义版权

为了自定义和覆盖版权声明,请扩展主题并覆盖 copyright.html 部分,这通常包括 mkdocs.yml 中设置的版权属性。