如何在GitHub风格的Markdown中添加脚注?

时间:2014-08-30 07:01:53

标签: markdown github-flavored-markdown multimarkdown

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

Some long sentence. [^footnote]

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

我关注this guide并且我认为我没有做错任何事。有人可以指出我的错误吗?

10 个答案:

答案 0 :(得分:268)

在上一个答案中稍微扩展一下,您也可以在此处点击脚注链接。首先在底部定义脚注,如下所示

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

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

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

答案 1 :(得分:171)

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

¹当然这并不理想,因为你现在负责保持脚注的编号。如果你只有一两个,它的效果相当不错。

答案 2 :(得分:142)

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

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

然后从脚注中链接回来。

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

这将在您的脚注内容的末尾添加一点,这会让您的读者回到包含脚注链接的行。

答案 3 :(得分:11)

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

  1. 使用方括号中的数字标记要插入页脚链接的位置,I.E。 [1]

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

  3. 预览后,它将在帖子正文中呈现为编号链接。

答案 4 :(得分:7)

我无法让Surya和Matteo的解决方案发挥作用。例如,&#34;(#f1)&#34;只显示为文本,并没有成为链接。然而,他们的解决方案使我的解决方案略有不同。 (我还将脚注和链接格式化为原始上标略有不同。)

在正文中:

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.

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

答案 5 :(得分:6)

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

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

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

答案 6 :(得分:6)

尽管问题是关于GitHub风格的Markdown,但我认为值得一提的是as of 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[]

Documentation along with the final result is here

答案 7 :(得分:5)

这是Eli Holmes'answer的一种变体,在不使用乳胶的情况下对我有用:

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

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

Example

答案 8 :(得分:3)

我使用了Mateo解决方案的变体。我在用github风格的markdown(gfm)编写的Rmd文件中使用它,用于Jekyll驱动的网站,但是相同的Rmd文件被用于在各种上下文中生成pdf。 Rmd文件很重,数学在网站上显示MathJax。因此,我需要一个与gfm一起使用的解决方案,该解决方案通过Jekyll处理,与pandoc-&gt; 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的任何地方。我在最后列出一个列表,所以它们在技术上是尾注。

答案 9 :(得分:2)

这对我有用:

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

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