跳转至

设置页脚

项目文档的页脚是添加链接的好地方 您或您的公司用作额外营销的网站或平台 渠道,例如:fontawesome品牌乳齿象:{ style="color: #5A4CE0" }或 :fontawesome brands youtube:{ style="color: #EE0F0F" },您可以轻松访问 通过mkdocs.yml进行配置。

配置

导航

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

theme:
  features:
    - navigation.footer

社交链接

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

extra:
  social:
    - icon: fontawesome/brands/mastodon # (1)!
      link: https://fosstodon.org/@squidfunk
  1. 输入几个关键字,使用我们的[图标搜索]找到完美的图标,然后 单击短代码将其复制到剪贴板:

    每个链接都有以下属性:

    此属性必须包含指向与主题绑定的任何图标的有效路径, 否则构建将不会成功。一些流行的选择:

    • 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

    此属性必须设置为包含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>
    

    此属性用作链接的“title”属性,可以设置为 可辨别的名称,以提高可访问性:

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

    版权声明

    自定义版权横幅可以作为页脚的一部分呈现,即 显示在社交链接旁边。它可以被定义为“mkdocs.yml”的一部分:

    copyright: Copyright &copy; 2016 - 2020 Martin Donath
    

    发电机通知

    页脚显示了一个_Made with Material for MkDocs_通知,表示如何 该网站已生成。可以通过以下选项删除通知 通过mkdocs.yml

    extra:
      generator: false
    

    请在删除发电机通知之前阅读此内容

    页脚中微妙的__Made with Material for MkDocs__提示是 这个项目如此受欢迎的原因,因为它告诉用户 生成网站,帮助新用户发现此项目。之前 删除请考虑您正在享受@squidfunk的好处 免费工作,因为这个项目是开源的,有许可证。 这个项目花了数千个小时,其中大部分 没有任何经济回报。

    Thus, if you remove this notice, please consider sponsoring the project. Thank you

    使用

    隐藏上一页/下一页链接

    显示上一页和下一页链接的页脚导航可以隐藏 具有前体“隐藏”属性。在a的顶部添加以下行 Markdown文件:

    ---
    hide:
      - footer
    ---
    
    # Page title
    ...
    

    自定义

    自定义版权

    In order to customize and override the copyright notice, extend the theme and override the copyright.html partial, which normally includes the copyright property set in mkdocs.yml.