如何为 GitHub 风格的 Markdown 添加脚注？

Question

我只是想在我的 GitHub Gist中添加脚注，但它不起作用：

Some long sentence. [^footnote]

[^footnote]: Test, [Link](https://google.com).

我正在遵循本指南，我认为我没有做错任何事情。 有人可以指出我的错误吗？

Answer 1

对上一个答案进行一点扩展，您也可以在此处使脚注链接可点击。 首先像这样定义底部的脚注

<a name="myfootnote1">1</a>: Footnote content goes here

然后像这样在文档中的其他地方引用它

<sup>[1](#myfootnote1)</sup>

Answer 2

GitHub Flavored Markdown 不支持脚注，但您可以使用 Unicode 字符或上标标签手动伪造它¹，例如<sup>1</sup> 。

¹当然这并不理想，因为您现在负责维护脚注的编号。 但是，如果您只有一两个，它的效果还不错。

Answer 3

进一步扩展之前的答案，您可以在脚注的链接中添加一个id属性：

 Bla bla <sup id="a1">[1](#f1)</sup>

然后从脚注中，链接回它。

<b id="f1">1</b> Footnote content here. [↩](#a1)

这将在脚注内容的末尾添加一个小↩ ，这会将您的读者带回到包含脚注链接的行。

Answer 4

我无法让 Surya 和 Matteo 的解决方案发挥作用。 例如，“(#f1)”只是显示为文本，并没有成为链接。 然而，他们的解决方案让我得到了稍微不同的解决方案。 （我还对脚注和返回原始上标的链接进行了稍微不同的格式化。）

在正文中：

Yadda yadda<a href="#note1" id="note1ref"><sup>1</sup></a>

在文件末尾：

<a id="note1" href="#note1ref"><sup>1</sup></a>Here is the footnote text.

单击脚注中的上标返回原始文本中的上标。

Answer 5

虽然我不知道它是否在任何地方有正式记录，但您可以在 Github 中做页脚注释。

1. 用方括号括起来的数字标记要插入页脚链接的位置，IE [1]

2. 在帖子的底部，参考编号标记，后跟冒号和链接，IE [1]: http://www.example.com/link1

一旦您预览它，它将在帖子正文中呈现为编号链接。

Answer 6

对于简短的笔记，提供一个带有标题属性的锚元素会创建一个“工具提示”。

<a title="Note text goes here."><sup>n</sup></a>

否则，对于更多涉及的笔记，看起来最好的办法是手动维护命名链接。

Answer 7

这对我有用：

blablabla [<sup>1</sup>](#1) blablabla

脚注：参考 blablabla <a class="anchor" id="1"></a>

Answer 8

这是Eli Holmes的答案的变体，它在不使用乳胶的情况下对我有用：

Text<span id="a1">[¹](#1)</span>

<span id="1">¹</span> Footnote.[⏎](#a1)<br>

例子

Answer 9

我使用了 Mateo 解决方案的变体。 我在用 github 风格的 Markdown (gfm) 编写的 Rmd 文件中使用它，用于 Jekyll 驱动的网站，但相同的 Rmd 文件被用于在各种上下文中生成 pdf。 Rmd 文件包含大量数学运算，并且数学运算与 MathJax 一起显示在网站上。 所以我需要一个与 gfm 一起工作的解决方案，它通过 Jekyll 处理，与 pandoc->pdflatex 一起工作，并且与 MathJax 兼容。

来自 Rmd 文件的片段（即 gfm）

Here is a paragraph with an footnote <span id="a1">[[1]](#f1)</span>.

Footnotes
=========

1. <span id="f1"></span> This is a footnote. [$\hookleftarrow$](#a1)

$\\hookleftarrow$是乳胶，这对我$\\hookleftarrow$ ，因为我总是启用 MathJax。 我用它来确保它在我的 pdf 文件中正确显示。 我将脚注放在方括号中，因为如果我在一些内联数学上放置脚注，上标会令人困惑。

这是在行动： https : //eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

这些音符可以放在 Rmd 的任何位置。 我在最后放了一个列表，所以它们在技术上是尾注。

Answer 10

虽然问题是关于 GitHub 风格的 Markdown，但我认为值得一提的是， 截至 2013 年，GitHub 支持内置了此功能的AsciiDoc 。 您只需要使用.adoc扩展名重命名您的文件并使用：

A statement.footnote:[Clarification about this statement.]

A bold statement!footnote:disclaimer[Opinions are my own.]

Another bold statement.footnote:disclaimer[]

文档和最终结果在这里。

Answer 11

2021 年 9 月：脚注在这里！

“ Markdown 字段现在支持脚注”

脚注可让您参考相关信息，而不会中断您想说的话：

 Here is a simple footnote[^1]. With some additional text after it. [^1]: My reference.

您现在可以在任何 Markdown 字段中使用脚注语法！

脚注显示为上标链接。 单击它们可跳转到其参考信息，显示在文档底部的新部分中：

参见 文档。

Answer 12

这个适用于 Kaggle notebook markdown：

Tell the story here.[<sup>[1]</sup>](#f1)

<span id="f1">[1]</span> Detail reference here.

Answer 13

我一直在寻找相同的内容，并想出了以下内容，这是一个脚注，可在外部选项卡中打开链接。

myfootnote^[Please see at: <a href="copylink" 
target="_blank">copylink</a> ]