Come aggiungere note a piè di pagina al Markdown al gusto di GitHub?

273

Sto solo cercando di aggiungere note a piè di pagina nel mio GitHub Gist , ma non funziona:

Some long sentence. [^footnote]

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

Sto seguendo questa guida e non credo di fare qualcosa di sbagliato. Qualcuno può sottolineare il mio errore?

markdown github-flavored-markdown multimarkdown

— Enrico Susatyo
fonte

1

fletcher.github.io/peg-multimarkdown Nota: attualmente, il software wiki Github supporta Markdown, ma non MultiMarkdown Dove è documentato che funzionerà?

— ta.speot.is

1

@EnricoSusatyo Non in chiaro markdown, ma per esempio Pandoc lo supporta

— mb21

2

È interessante notare che il markdown di GitLab supporta la [^footnote]sintassi, anche prima che venisse ufficialmente aggiunto alla documentazione

— hmijail piange le dimissioni il

1

@hmijail ti riferisci alla nota a piè di pagina di GitLab, non a Github come stava chiedendo l'OP.

— Devy,

1

@Devy, sì, ecco perché ho detto "markdown di GitLab". Potrebbe essere ancora utile, dato che l'implementazione degli aromi di GitLab sembra essere basata sull'aroma di GitHub e che in generale Markdown, i suoi aromi e le sue implementazioni sono un disastro. Riepilogo: "nel caso provi anche questo".

— Hmijail piange le dimissioni il

218

GitHub Flavored Markdown non supporta le note a piè di pagina, ma puoi falsificarlo manualmente¹ con caratteri Unicode o tag in apice, ad es 1.

¹ Naturalmente questo non è l'ideale, poiché ora sei responsabile del mantenimento della numerazione delle tue note. Funziona abbastanza bene se ne hai solo uno o due, però.

— Chris
fonte

Grazie, mi piace anche il modo in cui altri siti hanno collegamenti a piè di pagina cliccabili, ma suppongo che questo potrebbe essere l'unico modo per farlo in GitHub.

— Enrico Susatyo,

6

Puoi anche usare numeri regolari racchiusi tra parentesi quadre [1], che è una convenzione piuttosto consolidata per le note a piè di pagina nella mia esperienza. (Accidenti, perché non posso fare interruzioni di riga nei commenti.) [1] Vale a dire le note di Pandoc Mandoc meno il cursore.

— Guildenstern,

342

Espandendo un po 'la risposta precedente, è possibile rendere cliccabili anche i collegamenti a piè di pagina qui. Per prima cosa definisci la nota in fondo in questo modo

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

Quindi fai riferimento in qualche altro punto del documento come questo

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

— suryasankar
fonte

2

Questa è una bella risposta in mezzo. Mantiene il chiarimento delle intenzioni senza, IMO , troppo gonfio per la formattazione.

— kayleeFrye_onDeck,

3

L'uso di riferimenti non numerici risolve il problema sopra menzionato del mantenimento di riferimenti numerici sequenziali - Example [[TPL]](#TPL)... #### Notes...<a name="TPL">[TPL]</a> footnote template

— Randall Whitman,

4

Non perdere la parte 2 nella risposta di @ Matteo di seguito. Ero così pieno di questa risposta (grazie) che quasi non mi presi la briga di scorrere verso il basso. . .

— Guardare il

180

Espandendo ulteriormente le risposte precedenti, puoi aggiungere un idattributo al link della tua nota a piè di pagina:

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

Quindi, all'interno della nota a piè di pagina, ricollegalo.

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

Questo aggiungerà un po ' ↩alla fine del contenuto della tua nota a piè di pagina, il che riporta i tuoi lettori alla riga che contiene il link della nota a piè di pagina.

— Matteo
fonte

8

Aggiungendo una correzione minore alla risposta di @ Matteo sopra, ho dovuto usare nameinvece che idnella chiamata alla nota a piè di pagina. Bla bla [1](#f1)

— Vale a

2

Grazie @oldfartdeveloper. Sembra che sia namee iddi lavoro per i file README su github.com .. non ho ancora testato GIST però.

— Matteo,

1

Per coloro che trovano queste domande e risposte nel 2020 circa: questa risposta funziona su GitHub, PLUS ha la funzione aggiuntiva: ritorno alla nota a piè di pagina-link-clic . Ho trovato un avvertimento minore (spiegato qui) , ma questa è LA risposta afaic.

— Seamus,

13

Non sono riuscito a far funzionare le soluzioni di Surya e Matteo. Ad esempio, "(# f1)" è stato appena visualizzato come testo e non è diventato un collegamento. Tuttavia, le loro soluzioni mi hanno portato a una soluzione leggermente diversa. (Ho anche formattato la nota a piè di pagina e il collegamento al apice originale in modo leggermente diverso.)

Nel corpo del testo:

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

Alla fine del documento:

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

Facendo clic sull'apice nella nota a piè di pagina si ritorna all'apice nel testo originale.

— Marte
fonte

Interessante. Hai usato HTML dove @Matteo ha usato GFM. Sono stato in grado di far funzionare la sua soluzione, ma ha richiesto un po 'di confusione . Pensi che questa sia una stranezza nel motore di rendering di GitHub?

— Seamus,

Non ne ho idea, @Seamus. Per quanto ricordo, c'è stato un po 'di tentativi ed errori quando stavo cercando di capirlo.

— Marte,

1

È una soluzione intelligente. E sì - è ancora dove siamo oggi - tentativi ed errori :)

— Seamus il

12

Anche se non so se sia ufficialmente documentato da nessuna parte, puoi fare note a piè di pagina in Github.

Contrassegnare il punto in cui si desidera inserire il collegamento a piè di pagina con un numero racchiuso tra parentesi quadre, IE [1]
Nella parte inferiore del post, fai un riferimento al marcatore numerato e seguito da due punti e dal link, IE [1]: http://www.example.com/link1

E una volta visualizzato l'anteprima, verrà visualizzato come collegamenti numerati nel corpo del post.

— Devy
fonte

5

Questo non genera un elenco di collegamenti alla fine del documento. Come nelle pagine di Wikipedia.

— milosa,

dovrebbero esserci due punti dopo le parentesi quadre?

— sAguinaga,

18

Questa non è una nota a piè di pagina, questo è un collegamento.

— David Moles,

step #1non ha funzionato come collegamento al markdown di github (dicembre 2018).

— Ruhong,

7

Per brevi note, fornire un elemento di ancoraggio con un attributo title crea una "descrizione comando".

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

Altrimenti, per le note più coinvolte, sembra che la tua scommessa migliore sia mantenere manualmente i collegamenti nominati.

— Traube ricco
fonte

1

Questo non funzionava in una pagina di

— markdown di

4

Questo funziona per me:

blablabla [1](#1)blablabla

note a piè di pagina: riferimento a blablabla <a class="anchor" id="1"></a>

— aerijman
fonte

3

Ho usato una variante della soluzione di Mateo. Sto usando questo nei file Rmd scritti in markdown con sapore github (gfm) per un sito Web basato su Jekyll, ma gli stessi file Rmd vengono utilizzati per produrre pdf in vari contesti. I file Rmd sono pesanti in matematica e la matematica viene visualizzata con MathJax sul sito Web. Quindi avevo bisogno di una soluzione che funzioni con gfm, che viene elaborata tramite Jekyll, funziona con pandoc-> pdflatex ed è compatibile con MathJax.

snippet dal file Rmd (che è 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, che funziona per me poiché ho sempre abilitato MathJax. Lo uso per assicurarmi che venga visualizzato correttamente nei miei pdf. Metto le mie note a piè di pagina tra parentesi quadre perché l'apice è confuso se sto mettendo una nota a piè di pagina su alcuni calcoli matematici in linea.

Eccolo in azione: https://eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

Queste note possono essere inserite ovunque nell'Rmd. Sto inserendo un elenco alla fine, quindi sono tecnicamente note di chiusura.

— Eli Holmes
fonte

Leggermente tangenziale alla domanda del PO, ma alla fine mi piace molto la tua "soluzione che funziona con gfm che viene elaborata tramite Jekyll, funziona con pandoc-> pdflatex ed è compatibile con MathJax". Esempio pulito.

— boweeb,

0

Ecco una variante di Eli Holmes ' risposta che ha funzionato per me senza usare lattice:

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

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

Esempio

— Scott Gardner
fonte

0

Sebbene la domanda riguardi Markdown al gusto di GitHub, penso che valga la pena menzionarlo dal 2013 , GitHub supporta AsciiDoc che ha questa funzionalità integrata. Devi solo rinominare il tuo file con .adocun'estensione e usare:

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

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

Another bold statement.footnote:disclaimer[]

La documentazione insieme al risultato finale è qui .

— Doron Behar
fonte