Как добавить сноски в Markdown со вкусом GitHub?

Я просто пытаюсь добавить сноски в свой GitHub Gist , но это не работает:

Some long sentence. [^footnote]

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

Я следую этому руководству и не думаю, что делаю что-то не так. Кто-то может указать на мою ошибку?

GitHub Flavored 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)

Это добавит немного ↩в конце содержания вашей сноски, что вернет ваших читателей к строке, содержащей ссылку на сноску.

Я не смог заставить работать решения Сурьи и Маттео. Например, «(# 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.

При нажатии на верхний индекс в сноске возвращается верхний индекс в исходном тексте.

Хотя я не знаю, официально ли это где-либо задокументировано, вы можете делать заметки в нижнем колонтитуле в Github

1. Отметьте место, куда вы хотите вставить ссылку нижнего колонтитула, с помощью числа, заключенного в квадратные скобки, т.е. [1]

2. В нижней части поста сделайте ссылку на пронумерованный маркер, за которым следует двоеточие и ссылка, IE [1]: http://www.example.com/link1

И после предварительного просмотра он будет отображаться в виде пронумерованных ссылок в теле сообщения.

Для коротких заметок предоставление элемента привязки с атрибутом title создает «всплывающую подсказку».

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

В противном случае, для более заметных заметок, похоже, вам лучше всего поддерживать именованные ссылки вручную.

Это работает для меня:

блаблабла [<sup>1</sup>](#1)блаблабла

сноски: ссылка на блаблабла <a class="anchor" id="1"></a>

Я использовал вариант решения Матео. Я использую это в файлах Rmd, написанных с использованием разметки github (gfm) для сайта на платформе Jekyll, но те же файлы 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. Я добавляю список в конце, чтобы они были технически сносками.

Вот вариант ответа Эли Холмса , который работал для меня без использования латекса:

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

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

пример

Хотя вопрос касается Markdown со вкусом GitHub, я думаю, стоит упомянуть, что с 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[]

Документация вместе с окончательным результатом находится здесь .