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

Some long sentence. [^footnote]

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

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


当前回答

我用了马特奥解决方案的一个变种。我在一个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的任何地方。我在最后放了一个列表,所以它们在技术上是尾注。

其他回答

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

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

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

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

在想要插入页脚链接的地方用方括号括起来的数字标记出来,即[1] 在文章的底部,引用编号标记,后跟冒号和链接,即[1]:http://www.example.com/link1

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

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

文档和最终结果在这里。

我用了马特奥解决方案的一个变种。我在一个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的任何地方。我在最后放了一个列表,所以它们在技术上是尾注。

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

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