Comment ajouter des notes de bas de page à Markdown aromatisé GitHub?


273

J'essaie simplement d'ajouter des notes de bas de page dans mon GitHub 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 fais quelque chose de mal. Quelqu'un peut-il signaler mon erreur?


1
fletcher.github.io/peg-multimarkdown Remarque: Actuellement, le logiciel wiki Github prend en charge Markdown, mais pas MultiMarkdown Où est-il documenté que cela va fonctionner?
ta.speot.is

1
@EnricoSusatyo Pas dans le démarque ordinaire, mais par exemple Pandoc le prend en charge
mb21

2
Fait intéressant, le démarquage de GitLab prend en charge la [^footnote]syntaxe, même avant qu'il ne soit officiellement ajouté à la documentation
hmijail pleure les démissionnaires

1
@hmijail vous faites référence à la note de bas de page de GitLab, pas à Github comme l'OP le demandait.
Devy

1
@Devy, oui, c'est pourquoi j'ai dit "démarque de GitLab". Pourrait encore être utile, étant donné que l'implémentation de la saveur de GitLab semble être basée sur la saveur de GitHub, et qu'en général Markdown, ses saveurs et ses implémentations sont un gâchis impie. Résumé: "juste au cas où essayez cela aussi".
hmijail pleure les démissionnaires

Réponses:


218

GitHub Flavoured 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 en exposant, par exemple <sup>1</sup>.

¹ Bien sûr, ce n'est pas idéal, car vous êtes maintenant responsable du maintien de la numérotation de vos notes de bas de page. Cela fonctionne assez bien si vous n'en avez qu'un ou deux, cependant.


Merci, j'aime aussi la façon dont d'autres sites ont des liens de note de bas de page cliquables, mais je suppose que cela pourrait être la seule façon de le faire dans GitHub.
Enrico Susatyo

6
Vous pouvez également utiliser des nombres réguliers entre crochets [1], ce qui est une convention assez établie pour les notes de bas de page en clair selon mon expérience. (Mon Dieu, pourquoi je ne peux pas faire de sauts de ligne dans les commentaires.) [1] C'est-à-dire comme les notes de bas de page de Pandoc Mandoc moins le curseur.
Guildenstern

342

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 référencez-le à un autre endroit dans le document comme celui-ci

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

2
C'est une belle réponse intermédiaire. Il maintient clarifier l'intention sans, OMI , trop de ballonnement pour le formatage.
kayleeFrye_onDeck

3
L'utilisation de références non numériques évite le problème mentionné ci-dessus de maintenir des références numériques séquentielles - Example [[TPL]](#TPL)... #### Notes...<a name="TPL">[TPL]</a> footnote template
Randall Whitman

4
Ne manquez pas la partie 2 de la réponse de @ Matteo ci-dessous. J'étais tellement choqué par cette réponse (merci) que je n'ai presque pas pris la peine de faire défiler vers le bas. . .
Wardw

180

En développant les réponses précédentes encore plus loin, vous pouvez ajouter un idattribut 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, liez-la à nouveau.

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

Cela ajoutera un peu à 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.


8
Ajout d'une correction mineure à la réponse de @ Matteo ci-dessus, j'ai dû utiliser nameau lieu de iddans l'appel à la note de bas de page. Ie <p>Bla bla <sup name="a1">[1](#f1)</sup>
oldfartdeveloper

2
Merci @oldfartdeveloper. Il semble que tous les deux nameet idfonctionnent pour les fichiers README sur github.com .. n'ont cependant pas testé les gists.
Matteo

1
Pour ceux qui trouvent ce Q&A dans environ 2020: Cette réponse fonctionne sur GitHub, PLUS elle a la fonctionnalité supplémentaire: lien de retour à la note de bas de page sur lequel vous avez cliqué . J'ai trouvé une mise en garde mineure (expliquée ici) , mais c'est LA réponse afaic.
Seamus

13

Je n'ai pas réussi à faire fonctionner les solutions de Surya et Matteo. Par exemple, "(# f1)" était simplement affiché sous forme de texte et n'est pas devenu un lien. Cependant, leurs solutions m'ont conduit à une solution légèrement différente. (J'ai également formaté la note de bas de page et le lien vers l'exposant d'origine 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.

Cliquer sur l'exposant dans la note de bas de page revient à l'exposant dans le texte original.


Intéressant. Vous avez utilisé HTML où @Matteo a utilisé GFM. J'ai réussi à faire fonctionner sa solution, mais cela a nécessité un peu de violon . Pensez-vous que c'est une bizarrerie dans le moteur de rendu de GitHub?
Seamus

Je n'en ai aucune idée, @Seamus. Si je me souviens bien, il y a eu un peu d'essais et d'erreurs lorsque j'ai essayé de le comprendre.
Mars

1
C'est une solution intelligente. Et oui - c'est toujours là où nous en sommes aujourd'hui - essais et erreurs :)
Seamus

12

Bien que je ne sache pas si c'est officiellement documenté quelque part, vous pouvez faire 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 nombre entre crochets, IE [1]

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

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


5
Cela ne génère cependant pas de liste de liens à la fin de votre document. Comme sur les pages Wikipedia.
milosa

devrait-il y avoir deux points après les crochets?
sAguinaga

18
Ce n'est pas une note de bas de page, c'est un lien.
David Moles

l'étape #1n'a pas fonctionné comme un lien sur le démarque de github (décembre 2018).
ruhong

7

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 impliquées, il semble que votre meilleur pari est de maintenir manuellement les liens nommés.


1
Cela n'a pas fonctionné dans une page de démarque GitHub Enterprise 2.8
yegeniy

4

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>


3

J'ai utilisé une variante de la solution de Mateo. J'utilise ceci dans des fichiers Rmd écrits dans un démarquage aromatisé github (gfm) pour un site Web propulsé par Jekyll, mais les mêmes fichiers Rmd sont utilisés pour produire des fichiers PDF dans divers contextes. Les fichiers Rmd sont lourds en mathématiques et les mathématiques sont affichées avec MathJax sur le site Web. J'avais donc besoin d'une solution qui fonctionne avec gfm qui est traitée via Jekyll, fonctionne avec pandoc-> pdflatex et est compatible avec MathJax.

extrait de 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 le latex, qui fonctionne pour moi car j'ai toujours MathJax activé. J'utilise cela pour m'assurer qu'il s'affiche correctement dans mes fichiers PDF. Je mets mes notes de bas de page entre crochets parce que l'exposant est déroutant si je mets une note de bas de page sur des mathématiques 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 le Rmd. Je mets une liste à la fin, donc ce sont techniquement des notes de fin.


Légèrement tangentiel à la question de l'OP mais finalement j'aime vraiment votre "solution qui fonctionne avec gfm qui est traitée via Jekyll, fonctionne avec pandoc-> pdflatex et est compatible avec MathJax". Un bel exemple.
boweeb


0

Bien que la question concerne le Markdown aromatisé GitHub, je pense qu'il convient de mentionner qu'à partir de 2013 , GitHub prend en charge AsciiDoc qui intègre cette fonctionnalité. Il vous suffit de renommer votre fichier avec une .adocextension et d'utiliser:

A statement.footnote:[Clarification about this statement.]

A bold statement!footnote:disclaimer[Opinions are my own.]

Another bold statement.footnote:disclaimer[]

La documentation avec le résultat final est ici .

En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.