web-dev-qa-db-fra.com

Comment ajouter des notes de bas de page à Markdown à saveur de GitHub?

J'essaie simplement d'ajouter des notes de bas de page dans mon GistHub Gist , mais cela ne fonctionne pas:

Some long sentence. [^footnote]

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

Je suis ce guide et je ne pense pas que je fasse quelque chose de mal. Quelqu'un peut-il signaler mon erreur?

224
Enrico Susatyo

GitHub Flavored Markdown ne prend pas en charge les notes de bas de page, mais vous pouvez le simuler manuellement¹ avec des caractères Unicode ou des balises exposant, par exemple. <sup>1</sup>.

"Bien entendu, ce n’est pas idéal, vous êtes maintenant responsable du maintien de la numérotation de vos notes de bas de page. Cela fonctionne raisonnablement bien si vous n'en avez qu'un ou deux.

178
Chris

En développant un peu la réponse précédente, vous pouvez également rendre les liens de note de bas de page cliquables ici. Définissez d'abord la note de bas de page comme ceci

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

Puis faites référence à un autre endroit dans le document comme celui-ci

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

En développant encore les réponses précédentes, vous pouvez ajouter un attribut id au lien de votre note de bas de page:

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

Ensuite, dans la note de bas de page, renvoyez-la à celle-ci.

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

Cela ajoutera un petit à la fin du contenu de votre note de bas de page, ce qui ramènera vos lecteurs à la ligne contenant le lien de la note de bas de page.

149
Matteo

Bien que je ne sache pas si cela est officiellement documenté, vous pouvez créer des notes de bas de page dans Github.

  1. Marquez l'endroit où vous souhaitez insérer le lien de pied de page avec un numéro entre crochets, I.E. [1]

  2. Sur le bas du message, faites une référence du marqueur numéroté et suivi d'un deux-points et du lien, I.E. [1]: http://www.example.com/link1

Et une fois prévisualisé, il sera rendu sous forme de liens numérotés dans le corps du message.

11
Devy

Je n'ai pas réussi à faire fonctionner les solutions de Surya et de Matteo. Par exemple, "(# f1)" était simplement affiché sous forme de texte et ne devenait pas un lien. Cependant, leurs solutions m'ont amené à une solution légèrement différente. (J'ai également formaté la note de bas de page et le lien de retour en exposant un peu différemment.)

Dans le corps du texte:

Yadda yadda<a href="#note1" id="note1ref"><sup>1</sup></a>

A la fin du document:

<a id="note1" href="#note1ref"><sup>1</sup></a>Here is the footnote text.

En cliquant sur l’exposant dans la note de bas de page, on retourne à l’exposant dans le texte original.

7
Mars

Pour les notes courtes, fournir un élément d'ancrage avec un attribut title crée une "info-bulle".

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

Sinon, pour les notes plus compliquées, il semble que votre meilleur choix est de maintenir manuellement les liens nommés.

6
Rich Traube

J'ai utilisé une variante de la solution de Mateo. J'utilise ceci dans des fichiers Rmd écrits en github flavoured markdown (gfm) pour un site Web alimenté par Jekyll, mais les mêmes fichiers Rmd sont utilisés pour produire des fichiers PDF dans différents contextes. Les fichiers Rmd sont lourds en mathématiques et sont affichés avec MathJax sur le site Web. Il me fallait donc une solution compatible avec gfm, traitée via Jekyll, compatible avec pandoc-> pdflatex et compatible avec MathJax.

extrait du fichier Rmd (qui est 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$ est en latex, ce qui fonctionne pour moi car MathJax est toujours activé. J'utilise cela pour m'assurer qu'il apparaît correctement dans mes fichiers PDF. Je mets mes notes de bas de page entre crochets, car en exposant, il est difficile de mettre une note de bas de page sur un calcul mathématique en ligne.

Le voici en action: https://eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

Ces notes peuvent être placées n'importe où dans la Rmd. Je mets une liste à la fin pour que ce soit techniquement une note de fin.

3
Eli Holmes

Cela fonctionne pour moi:

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

notes de bas de page: référence à blablabla <a class="anchor" id="1"></a>

2
aerijman