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

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

Some long sentence. [^footnote]

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

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

Ответ 1

GitHub Flavored Markdown не поддерживает сноски, но вы можете вручную подделать его¹ с помощью символов Unicode или надстрочных тегов, например. <sup>1</sup>.

¹ Конечно, это не идеально, поскольку теперь вы отвечаете за поддержание нумерации ваших сносок. Он работает достаточно хорошо, если у вас есть только один или два.

Ответ 2

Развернувшись немного на предыдущем ответе, вы также можете сделать ссылки на сноску. Сначала определите сноску внизу, как это показано

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

Затем ссылайтесь на него в другом месте в документе, подобном этому

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

Ответ 3

Развернув предыдущие ответы еще дальше, вы можете добавить атрибут id в свою сноску:

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

Затем изнутри сноски вернитесь к нему.

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

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

Ответ 4

Для коротких заметок предоставление элемента привязки с атрибутом title создает "подсказку".

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

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

Ответ 5

Хотя я не знаю, официально ли он документально зарегистрирован, вы можете делать примечания нижнего колонтитула в Github.

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

  • В нижней части сообщения сделайте ссылку нумерационного маркера, а затем полуколумбу и ссылку I.E. [1]: http://www.example.com/link1

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

Ответ 6

Мне не удалось заставить решения 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.

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

Ответ 7

Я использовал вариант решения Mateo. Я использую это в файлах Rmd, написанных в gythub приправленной уценке (gfm) для веб-сайта Jekyll, но те же файлы Rmd используются для создания PDF файлов в различных контекстах. Файлы Rmd являются математически тяжелыми, и математика отображается с помощью MathJax на веб-сайте. Поэтому мне нужно решение, которое работает с gfm, которое обрабатывается через Jekyll, работает с pandoc- > pdflatex и совместимо с MathJax.

фрагмент из файла Rmd (который является gfm)

Here is a paragraph with a 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-19-FI-recursion-2/