脚注
脚注是向特定单词、短语或句子添加补充或附加信息的好方法,而不会打断文档的流程。Material for MkDocs 提供了定义、引用和渲染脚注的功能。
配置
这个配置添加了定义内联脚注的功能,然后在文档的所有 Markdown 内容下方渲染它们。在mkdocs.yml中添加以下行:
markdown_extensions:
- footnotes
查看附加的配置选项:
使用方法
添加脚注引用
脚注引用必须用方括号括起来,并且必须以插入符 ^ 开头,后面直接跟一个任意的标识符,类似于标准的 Markdown 链接语法。
带有脚注引用的文本Lorem ipsum[^1] dolor sit amet, consectetur adipiscing elit.[^2]
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
添加脚注内容
脚注内容必须使用与引用相同的标识符声明。它可以插入到文档的任意位置,并且始终在页面底部呈现。此外,自动添加了指向脚注引用的反向链接。
单行脚注
短脚注可以写在同一行上:
脚注[^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.