Skip to content

脚注

脚注是一种很好的方式,可以在不打断文档流的情况下,为特定的单词、短语或句子添加补充或额外的信息。Material for MkDocs 提供了定义、引用和渲染脚注的能力。

配置

此配置增加了定义内联脚注的能力,这些脚注会在文档的所有 Markdown 内容下方渲染。请在 mkdocs.yml 中添加以下行:

markdown_extensions:
  - footnotes

查看其他配置选项:

脚注工具提示

9.7.0

脚注可以作为内联工具提示进行渲染,因此用户可以在不离开文档上下文的情况下阅读脚注。可以在 mkdocs.yml 中通过以下方式启用脚注工具提示:

theme:
  features:
    - content.footnote.tooltips

我们的文档中启用了脚注工具提示,因此要尝试一下,您可以只需悬停或聚焦于本页面或我们文档的任何其他页面上的任何脚注。

使用

添加脚注引用

脚注引用必须用方括号括起来,并且必须以插入符号 ^ 开头,后面紧跟一个任意标识符,这与标准的 Markdown 链接语法类似。

带有脚注引用的文本
Lorem ipsum[^1] dolor sit amet, consectetur adipiscing elit.[^2]

Lorem ipsum1 dolor sit amet, consectetur adipiscing elit.2

添加脚注内容

脚注内容必须使用与引用相同的标识符进行声明。它可以在文档中的任意位置插入,并且始终在页面底部渲染。此外,自动添加指向脚注引用的反向链接。

单行脚注

短脚注可以写在同一行上:

脚注
[^1]: Lorem ipsum dolor sit amet, consectetur adipiscing elit.

多行脚注

段落可以写在下一行,并且必须缩进四个空格:

脚注
[^2]:
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

  1. Lorem ipsum dolor sit amet, consectetur adipiscing elit. 

  2. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.