GFM 脚注语法

GFM 脚注语法

GitHub Flavored Markdown 2021 起正式支持脚注:正文用 [^标签] 插入,文末写 [^标签]: 内容,可自动编号、生成返回链接,支持换行及 Markdown 嵌套;标签名可自定义,多次引用同脚注仅列一次,适合文档注释、参考文献,让长篇内容更整洁。

更新于 2025-08-31
651

效果

花野猫是世界上最帅的男人1

语法说明

GitHub Flavored Markdown(GFM)从 2021 年 9 月起正式支持脚注(footnote)。

如何使用

语法与 Pandoc、MultiMarkdown 等扩展 Markdown 基本一致,核心规则只有两步:

  1. 在正文中需要加注的位置插入标记

    这句话需要一个脚注[^1]。
  2. 在文档任意位置(通常放末尾)给出对应的脚注内容

    [^1]: 这里是脚注的具体说明,可以换行并包含其他 Markdown 语法。

完整示例

火影忍者中的主角是漩涡鸣人[^1]和佐助[^2]。
[^1]: 漩涡鸣人(うずまきナルト,Uzumaki Naruto)是《火影忍者》的主角,最终成为第七代火影。
[^2]: 宇智波佐助,火之国木叶隐村宇智波一族的天才忍者。

渲染效果

  • 正文中 [^1] 会被替换成一个带链接的上标数字。
  • 页面底部会出现一条编号列表,列出所有脚注内容,并附带返回正文的“↩”链接。

就像下面这样:

火影忍者中的主角是漩涡鸣人¹和佐助²。


¹ 漩涡鸣人(うずまきナルト,Uzumaki Naruto)是《火影忍者》的主角…… [↩]
² 宇智波佐助,火之国木叶隐村宇智波一族的天才忍者。 [↩]

注意事项

  • 标签名可自定义(字母、数字、下划线均可),只需正文标记与脚注定义保持一致。
  • GFM 会自动编号,因此标签本身不会显示,仅作为锚点。
  • 如果同一个标签被多次引用,脚注列表只会出现一次,且所有引用都指向同一条说明。

Footnotes

  1. 这根本不需要解释