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

Some long sentence. [^footnote]

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

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


当前回答

2021年9月:脚注在这里!

(2021年12月,如下所述,维基README。Md还不支持脚注)

“Markdown字段现在支持脚注” 脚注可以让你引用相关信息,而不会打断你想说的内容: 这里有一个简单的脚注[^1]。后面还有一些额外的文字。 [^1]:我的参考。 您现在可以在任何Markdown字段中使用脚注语法! 脚注显示为上标链接。单击它们可以跳转到它们的引用信息,显示在文档底部的新部分:

Cf。文档。

其他回答

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

文档和最终结果在这里。

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

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

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

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

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

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

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

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

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

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

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