跳转至

Footer 设置

文档的页面底部(Footer或页脚)是很好的位置来添加网站链接、或者其他的营销渠道，如 或 ， 可以通过 mkdocs.yml 来进行配置。

配置

导航

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

theme:
  features:
    - navigation.footer

社交媒体链接

社交媒体链接旁边可以给项目文档添加版权声明，在 mkdocs.yml 中添加：

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

  1. Enter a few keywords to find the perfect icon using our icon search and click on the shortcode to copy it to your clipboard:

    以下属性可用于所有链接：

    此属性必须包含与主题绑定的对应图标有效路径，否则构建将无法成功。例如一些主流的选择：

    • – fontawesome/brands/github
    • – fontawesome/brands/gitlab
    • – fontawesome/brands/x-twitter
    • – fontawesome/brands/mastodon automatically adds 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

    This property must be set to a relative or absolute URL including the URI scheme. All URI schemes are supported, including mailto and bitcoin:

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

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

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

    name 属性用作链接的 title 标题属性，可以设置为一个可识别的名称，以提高可识别性。会在鼠标移动到对象上时显示 name 的内容。

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

    版权声明

    自定义版权横幅可以呈现为页脚的一部分，即显示在社交媒体链接旁边(页面左侧)。可以直接在 mkdocs.yml 中定义：

    copyright: Copyright &copy; 2025 - 2025 Martin Donath

    网站生成器声明(Generator notice)

    页脚显示一个 Made with Material-for-MkDocs 提示来表示当前网站是基于什么生成器生成的。 可以在 mkdocs.yml 使用以下选项删除该通知

    extra:
  generator: false

    请阅读以下内容后，在考虑是否删除网站生成器声明

    在脚注中添加 Made with Material-for-MkDocs 提示是这个项目如此受欢迎的重要原因，因为他告诉用户当前网站是基于什么方式生成的，帮助新用户发现这个项目。 在删除前请考虑到你正在享受 @squidfunk 带来的好处，因为这个项目是开源的，并且有一个宽松的许可证。作者在这个项目上投入了数千小时，大部分时间没有任何经济回报。

    因此，如果您删除此通知，请考虑 赞助 该项目。Thank you

    使用

    隐藏 prev/next 链接

    通过 hide 属性设置可以隐藏页脚导航中的 “上一页”和“下一页”链接的。

    在 Markdown 文档的顶部添加如下内容

    ---
hide:
  - footer
---

# Page title
...

    自定义

    为了自定义和覆盖 copyright notice, extend the theme 和 override the copyright.html partial, 通常在 mkdocs.yml 中 copyright 属性进行设置。

    参考