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



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



Some long sentence. [^footnote]

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


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

550   7  

7 ответов:

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

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

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

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

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

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

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

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

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

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

нажав на верхний в примечании к Надстрочный знак в исходном тексте.

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

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

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

я использовал вариант решения Матео. Я использую это в файлах Rmd, написанных на GitHub flavored markdown (gfm) для веб-сайта с питанием от Jekyll, но те же файлы Rmd используются для создания PDF-файлов в различных контекстах. Файлы Rmd являются math heavy, и математика отображается с 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$ это latex, который работает для меня, так как у меня всегда включен MathJax. Я использую это, чтобы убедиться, что он правильно отображается в моих PDF-файлах. Я помещаю свои сноски в квадратные скобки, потому что Надстрочный индекс сбивает с толку, если я помещаю сноску на какую-то встроенную математику.

вот он в действии:https://eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

эти заметки могут быть помещены в любом месте в Rmd. Я помещаю в список в конце поэтому они технически Примечания.

Comments

    Ничего не найдено.