351

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

Some long sentence. [^footnote]

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

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

4

13 回答 13

412

稍微扩展上一个答案,您也可以在此处使脚注链接可单击。首先像这样定义底部的脚注

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

然后像这样在文档中的其他位置引用它

<sup>[1](#myfootnote1)</sup>
于 2015-04-01T06:29:09.000 回答
275

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

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

于 2014-08-30T16:33:40.923 回答
237
于 2015-08-20T13:37:30.613 回答
19

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

点击脚注中的上标返回到原文中的上标。

于 2017-03-04T18:05:44.770 回答
15

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

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

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

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

于 2016-08-23T21:13:16.600 回答
14

这对我有用:

喋喋不休[<sup>1</sup>](#1)_

脚注:提及 blablabla<a class="anchor" id="1"></a>

于 2018-10-09T23:34:00.733 回答
12

2021 年 9 月:脚注在这里!

(2021 年 12 月,如下所述,wikiREADME.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

参照。文档

于 2021-09-30T17:06:28.170 回答
12

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

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

否则,对于更多涉及的注释,您最好的选择是手动维护命名链接。

于 2016-11-10T17:25:53.643 回答
9

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

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

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

例子

于 2020-04-17T12:43:04.093 回答
8

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

文档和最终结果在这里

于 2020-04-27T09:33:14.287 回答
8

我使用了 Mateo 解决方案的变体。我在用 github 风格的 markdown (gfm) 为 Jekyll 支持的网站编写的 Rmd 文件中使用它,但相同的 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$是乳胶,这对我有用,因为我总是启用 MathJax。我用它来确保它在我的 pdf 中正确显示。我将脚注放在方括号中,因为如果我在某些内联数学上添加脚注,上标会令人困惑。

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

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

于 2017-12-15T19:51:49.093 回答
0

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

myfootnote^[Please see at: <a href="copylink" 
target="_blank">copylink</a> ]
于 2022-01-23T09:37:15.213 回答
0

这个适用于 Kaggle 笔记本降价:

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

<span id="f1">[1]</span> Detail reference here.
于 2021-10-25T13:16:30.350 回答