Wie füge ich Fußnoten zu Markdown mit GitHub-Geschmack hinzu?

273

Ich versuche nur, Fußnoten in meinen GitHub Gist einzufügen , aber es funktioniert nicht:

Some long sentence. [^footnote]

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

Ich folge dieser Anleitung und glaube nicht, dass ich etwas falsch mache. Kann jemand auf meinen Fehler hinweisen?

Enrico Susatyo
quelle
1
fletcher.github.io/peg-multimarkdown Hinweis: Derzeit unterstützt die Github-Wiki-Software Markdown, jedoch nicht MultiMarkdown. Wo ist dokumentiert, dass dies funktionieren wird?
ta.speot.is
1
@EnricoSusatyo Nicht in einfachem Abschlag, aber zum Beispiel unterstützt Pandoc es
mb21
2
Interessanterweise unterstützt GitLabs Markdown die [^footnote]Syntax, noch bevor sie offiziell in die Dokumentation aufgenommen wurde
hmijail trauert um die Rücktritte
1
@hmijail Sie beziehen sich auf die Fußnote von GitLab, nicht auf Github, wie das OP gefragt hat.
Devy
1
@ Devy, ja, deshalb habe ich "GitLab's Markdown" gesagt. Könnte immer noch nützlich sein, da die Flavour-Implementierung von GitLab auf der GitHub-Flavour zu basieren scheint und dass Markdown, seine Flavours und Implementierungen im Allgemeinen ein unheiliges Durcheinander sind. Zusammenfassung: "Nur für den Fall, versuchen Sie dies auch".
Hmijail trauert um den 9.

Antworten:

218

GitHub Flavored Markdown unterstützt keine Fußnoten, aber Sie können es manuell mit Unicode-Zeichen oder hochgestellten Tags fälschen, z <sup>1</sup>.

¹Natürlich ist dies nicht ideal, da Sie jetzt dafür verantwortlich sind, die Nummerierung Ihrer Fußnoten beizubehalten. Es funktioniert jedoch ziemlich gut, wenn Sie nur ein oder zwei haben.

Chris
quelle
Vielen Dank, ich mag auch, wie andere Websites anklickbare Fußnoten-Links haben, aber ich denke, dies ist möglicherweise die einzige Möglichkeit, dies in GitHub zu tun.
Enrico Susatyo
6
Sie können auch reguläre Zahlen in eckigen Klammern [1] verwenden, was meiner Erfahrung nach eine ziemlich etablierte Konvention für Klartext-Fußnoten ist. (Meine Güte, verdammt, warum kann ich in Kommentaren keine Zeilenumbrüche machen.) [1] Ich mag Pandoc Mandoc-Fußnoten abzüglich des Carets.
Guildenstern
342

Wenn Sie die vorherige Antwort ein wenig erweitern, können Sie die Fußnoten-Links auch hier anklickbar machen. Definieren Sie zuerst die Fußnote unten wie folgt

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

Verweisen Sie dann an einer anderen Stelle im Dokument wie folgt darauf

<sup>[1](#myfootnote1)</sup>
suryasankar
quelle
2
Dies ist eine schöne mittelgroße Antwort. Es behält die Klärung der Absicht bei, ohne, IMO , zu viel Aufblähen zum Formatieren.
KayleeFrye_onDeck
3
Die Verwendung nicht numerischer Referenzen vermeidet das oben erwähnte Problem der Aufrechterhaltung sequentieller numerischer Referenzen - Example [[TPL]](#TPL)... #### Notes...<a name="TPL">[TPL]</a> footnote template
Randall Whitman
4
Verpassen Sie nicht Teil 2 in der Antwort von @ Matteo unten. Ich war so begeistert von dieser Antwort (danke), dass ich mich fast nicht darum gekümmert habe, nach unten zu scrollen. . .
Wardw
177

Wenn Sie die vorherigen Antworten noch weiter erweitern, können idSie dem Link Ihrer Fußnote ein Attribut hinzufügen :

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

Verknüpfen Sie dann innerhalb der Fußnote wieder damit.

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

Dies fügt am Ende des Inhalts Ihrer Fußnote ein wenig hinzu , wodurch Ihre Leser zu der Zeile zurückkehren, die den Link der Fußnote enthält.

Matteo
quelle
8
Nachdem ich die Antwort von @ Matteo oben geringfügig korrigiert hatte, musste ich sie nameanstelle des idAufrufs der Fußnote verwenden. Bla bla <sup name="a1">[1](#f1)</sup>
Dh
2
Danke @oldfartdeveloper. Es scheint, dass beide nameund idfür README-Dateien auf github.com funktionieren.
Matteo
1
Für diejenigen, die diese Fragen und Antworten um 2020 finden: Diese Antwort funktioniert auf GitHub, PLUS und bietet die zusätzliche Funktion: Zurück zum Fußnoten-Link, auf den Sie geklickt haben . Ich habe eine kleine Einschränkung gefunden (hier erklärt) , aber dies ist DIE Antwort afaic.
Seamus
13

Ich war nicht in der Lage, die Lösungen von Surya und Matteo zum Laufen zu bringen. Zum Beispiel wurde "(# f1)" nur als Text angezeigt und wurde nicht zu einem Link. Ihre Lösungen führten mich jedoch zu einer etwas anderen Lösung. (Ich habe auch die Fußnote und den Link zum hochgestellten Original etwas anders formatiert.)

Im Textkörper:

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

Am Ende des Dokuments:

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

Wenn Sie in der Fußnote auf den hochgestellten Index klicken, kehren Sie zum hochgestellten Text im Originaltext zurück.

Mars
quelle
Interessant. Sie haben HTML verwendet, während @Matteo GFM verwendet hat. Ich konnte seine Lösung zum Laufen bringen, aber es erforderte ein wenig Fummelei . Denken Sie, dass dies eine Eigenart in der Rendering-Engine von GitHub ist?
Seamus
Ich habe keine Ahnung, @Seamus. Soweit ich mich erinnere, gab es ein bisschen Versuch und Irrtum, als ich versuchte, es herauszufinden.
Mars
1
Es ist eine clevere Lösung. Und ja - dort sind wir heute noch - Versuch und Irrtum :)
Seamus
12

Obwohl mir nicht bekannt ist, ob es irgendwo offiziell dokumentiert ist, können Sie in Github Fußzeilennotizen machen.

  1. Markieren Sie die Stelle, an der Sie den Fußzeilenlink einfügen möchten, mit einer Zahl in eckigen Klammern (IE) [1]

  2. Verweisen Sie am Ende des Beitrags auf den nummerierten Marker, gefolgt von einem Doppelpunkt und dem Link IE [1]: http://www.example.com/link1

Sobald Sie eine Vorschau anzeigen, wird es als nummerierter Link im Hauptteil des Beitrags gerendert.

Devy
quelle
5
Dies generiert jedoch keine Liste von Links am Ende Ihres Dokuments. Wie auf Wikipedia-Seiten.
Milosa
Sollte nach den eckigen Klammern ein Doppelpunkt stehen?
sAguinaga
17
Dies ist keine Fußnote, dies ist ein Link.
David Moles
step #1funktionierte nicht als Link zum Github-Markdown (Dezember 2018).
Ruhong
7

Wenn Sie für kurze Notizen ein Ankerelement mit einem title-Attribut versehen, wird ein "Tooltip" erstellt.

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

Andernfalls scheint es für komplexere Notizen am besten zu sein, benannte Links manuell zu pflegen.

Reiche Traube
quelle
1
Dies funktionierte nicht in einer GitHub Enterprise 2.8 Markdown-Seite
yegeniy
4

Das funktioniert bei mir:

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

Fußnoten: Verweis auf blablabla <a class="anchor" id="1"></a>

Aerijman
quelle
3

Ich habe eine Variante von Mateos Lösung verwendet. Ich verwende dies in Rmd-Dateien, die in Github Flavoured Markdown (gfm) für eine Jekyll-basierte Website geschrieben wurden, aber dieselben Rmd-Dateien werden verwendet, um PDFs in verschiedenen Kontexten zu erstellen. Die Rmd-Dateien sind mathematisch schwer und die Mathematik wird mit MathJax auf der Website angezeigt. Ich brauchte also eine Lösung, die mit gfm funktioniert, die über Jekyll verarbeitet wird, mit pandoc-> pdflatex funktioniert und mit MathJax kompatibel ist.

Ausschnitt aus der Rmd-Datei (die gfm ist)

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$ist Latex, was für mich funktioniert, da ich MathJax immer aktiviert habe. Ich benutze das, um sicherzustellen, dass es in meinen PDFs korrekt angezeigt wird. Ich setze meine Fußnoten in eckige Klammern, weil hochgestellt verwirrend ist, wenn ich eine Fußnote zu einer Inline-Mathematik schreibe.

Hier ist es in Aktion: https://eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

Diese Notizen können an einer beliebigen Stelle im RMD abgelegt werden. Ich füge am Ende eine Liste ein, damit es sich technisch gesehen um Endnoten handelt.

Eli Holmes
quelle
Mild tangential zur OP-Frage, aber letztendlich gefällt mir Ihre "Lösung, die mit gfm funktioniert, die über Jekyll verarbeitet wird, mit pandoc-> pdflatex funktioniert und mit MathJax kompatibel ist". Ordentliches Beispiel.
Boweeb
0

Hier ist eine Variation von Eli Holmes ' Antwort , die für mich ohne Latex funktioniert hat:

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

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

Beispiel

Scott Gardner
quelle
0

Obwohl es sich bei der Frage um Markdown mit GitHub-Geschmack handelt, sollte erwähnt werden, dass GitHub ab 2013 AsciiDoc unterstützt, in das diese Funktion integriert ist. Sie müssen Ihre Datei nur mit einer .adocErweiterung umbenennen und verwenden:

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

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

Another bold statement.footnote:disclaimer[]

Die Dokumentation zusammen mit dem Endergebnis finden Sie hier .

Doron Behar
quelle