如何添加脚注到github风味Markdown?

我只是试图在我的GitHub Gist中添加脚注，但它不起作用:

Some long sentence. [^footnote]


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

我遵循本指南，我不认为我做错了什么。有人能指出我的错误吗?

139719 次浏览
小开
最佳答案

GitHub flavour Markdown不支持脚注，但你可以手动使用Unicode字符或上标标记来伪造脚注，例如<sup>1</sup>。

¹当然这并不理想，因为你现在要负责维护脚注的编号。不过，如果你只有一个或两个，它工作得相当好。

小开

在前面的答案上稍微扩展一下，你也可以在这里设置脚注链接。首先像这样定义底部的脚注

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

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

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

进一步扩展前面的答案，你可以在脚注的链接中添加id属性:

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

然后从脚注中链接回它。

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

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

小开

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

  1. 在你想要插入页脚链接的地方用方括号括起来的数字标记出来，即[1]

  2. 在文章的底部，引用编号标记，后跟冒号和链接，即[1]: http://www.example.com/link1

一旦你预览它，它将呈现为编号的链接在文章的主体。

小开

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

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

否则，对于更复杂的注释，最好的方法似乎是手动维护命名链接。

小开

我无法让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.

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

小开

我用了马特奥解决方案的一个变种。我在一个Jekyll驱动的网站上使用github风味markdown (gfm)编写的Rmd文件中使用这一点，但相同的Rmd文件被用于在各种上下文中生成pdf。Rmd文件包含大量的数学运算，并且在网站上使用MathJax显示这些数学运算。所以我需要一个解决方案，通过Jekyll处理的gfm，与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$是latex，它适用于我，因为我总是启用MathJax。我用它来确保它在我的pdf文件中正确显示。我把脚注放在方括号里，因为如果我把脚注放在一些内联数学上，上标会让人困惑。

下面是它的动作:https://eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

这些笔记可以放在Rmd的任何地方。我在最后放了一个列表，所以它们在技术上是尾注。

小开

这对我来说很管用:

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

< p >脚注: 引用blablabla <a class="anchor" id="1"></a>

小开

这里是伊莱福尔摩斯' 回答的一个变体，它在没有使用latex的情况下为我工作:

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


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

< a href = " https://scotteg.github。io / Conquering-Capture-Lists noreferrer“rel = > < / >示例

小开

虽然这个问题是关于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[]

文档和最终结果在这里。

小开

2021年9月:脚注在这里!

(2021年12月，因为下面的评论, wiki README.md还不支持脚注)

“Markdown字段现在支持脚注"

脚注可以让你引用相关信息，而不会打断你想说的内容:

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


[^1]: My reference.

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

脚注显示为上标链接。单击它们可以跳转到它们的引用信息，显示在文档底部的新部分:

https://i1.wp.com/user-images.githubusercontent.com/2503052/135463148-0231966e-8631-41a1-b1a7-66746100d20a.gif?ssl=1

文档 Cf。

小开

这个方法适用于Kaggle笔记本markdown:

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


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

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

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

提交答案