脚注
脚注用于在文档中添加注释和引用,保持正文简洁的同时提供补充信息。这是 GFM 和许多 Markdown 扩展支持的功能。
基本语法
脚注由两部分组成:脚注引用和脚注定义。
创建脚注
这是一个脚注引用[^1]。
[^1]: 这是脚注的内容。
渲染效果:
这是一个脚注引用1。
语法规则
脚注引用:
- 使用
[^标识符]格式 - 标识符可以是数字或文字
- 标识符不区分大小写
脚注定义:
- 使用
[^标识符]:格式 - 冒号后是脚注内容
- 可以放在文档任意位置,通常放在末尾
脚注标识符
数字标识符
使用数字作为标识符是最常见的方式:
第一处引用[^1],第二处引用[^2]。
[^1]: 第一个脚注。
[^2]: 第二个脚注。
文字标识符
也可以使用有意义的文字作为标识符:
根据 CommonMark 规范[^commonmark],Markdown 是一种轻量级标记语言。
[^commonmark]: CommonMark 是 Markdown 的标准化规范。
标识符顺序
脚注的编号由引用顺序决定,而非定义顺序:
先引用第二个[^2],再引用第一个[^1]。
[^1]: 这是第一个脚注。
[^2]: 这是第二个脚注。
渲染时,第一个脚注会显示为 1,第二个显示为 2。
多行脚注
脚注内容可以跨越多行。
使用缩进
后续行缩进四个空格:
这是一个多行脚注[^multi]。
[^multi]: 这是脚注的第一行。
这是脚注的第二行。
这是脚注的第三行。
使用行末双空格
每行末尾添加两个空格:
[^multi]: 第一行内容
第二行内容
第三行内容
脚注中的格式化
脚注内容支持 Markdown 格式:
这是一个包含格式的脚注[^format]。
[^format]: 脚注中可以有 **粗体**、*斜体* 和 `代码`。
也可以包含 [链接](https://example.com)。
脚注的应用场景
引用来源
Markdown 由 John Gruber 于 2004 年创建[^source]。
[^source]: [Daring Fireball: Markdown](https://daringfireball.net/projects/markdown/)
补充说明
使用 CommonMark 规范[^note]可以确保文档在不同平台的一致性。
[^note]: CommonMark 是一个强定义的 Markdown 规范,解决了原始 Markdown 实现不一致的问题。
术语解释
GFM[^gfm] 是 GitHub 的 Markdown 扩展。
[^gfm]: GitHub Flavored Markdown,GitHub 在 CommonMark 基础上的扩展,增加了表格、任务列表等功能。
参考文献列表
本文参考了以下资料:
- CommonMark 规范[^cm]
- GFM 规范[^gfm]
- Markdown Guide[^guide]
[^cm]: [CommonMark Spec](https://commonmark.org/)
[^gfm]: [GitHub Flavored Markdown Spec](https://github.github.com/gfm/)
[^guide]: [Markdown Guide](https://www.markdownguide.org/)
脚注的位置
脚注定义可以放在文档的任意位置,渲染时会自动显示在文档末尾。但为了可读性,建议:
- 放在文档末尾
- 按引用顺序排列
- 使用有意义的标识符
脚注的限制
不支持的功能
- 脚注中不能嵌套脚注
- 某些渲染器不支持脚注
兼容性
脚注不是所有 Markdown 渲染器都支持:
- GitHub:支持
- GitLab:支持
- Obsidian:支持
- Typora:支持
- 部分 CMS:可能不支持
如果目标平台不支持脚注,可以使用链接替代:
这是引用[1]。
[1]: https://example.com "引用来源"
最佳实践
有意义的标识符
使用有意义的标识符,便于维护:
推荐:
根据规范[^commonmark-spec]...
[^commonmark-spec]: CommonMark 规范说明。
不推荐:
根据规范[^1]...
[^1]: CommonMark 规范说明。
简洁的脚注内容
脚注应该简洁,过长内容考虑使用链接:
推荐:
详见官方文档[^docs]。
[^docs]: [CommonMark 文档](https://commonmark.org/)
不推荐:
[^docs]: CommonMark 是一个强定义、高度兼容的 Markdown 规范。它由 John MacFarlane 领导开发...(大段文字)
统一的格式
在同一文档中保持脚注格式一致:
- 标识符风格(数字或文字)
- 定义位置
- 内容格式
小结
本章学习了脚注的使用方法:
- 基本语法:
[^标识符]引用,[^标识符]:定义 - 标识符:数字或文字,按引用顺序编号
- 多行脚注:使用缩进或行末双空格
- 应用场景:引用来源、补充说明、术语解释
- 最佳实践:有意义的标识符、简洁内容、统一格式
练习
- 创建一个包含多个脚注的文档
- 使用文字标识符创建脚注
- 创建一个多行脚注
- 使用脚注创建参考文献列表