¿Cómo agregar notas al pie a Markit con sabor a GitHub?

273

Solo estoy tratando de agregar notas al pie en mi GitHub Gist , pero no funciona:

Some long sentence. [^footnote]

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

Estoy siguiendo esta guía y no creo que esté haciendo nada malo. ¿Alguien puede señalar mi error?

Enrico Susatyo
fuente
1
fletcher.github.io/peg-multimarkdown Nota: Actualmente, el software wiki de Github admite Markdown, pero no MultiMarkdown ¿Dónde se documenta que esto va a funcionar?
ta.speot.is
1
@EnricoSusatyo No está en una rebaja simple, pero por ejemplo Pandoc lo admite
mb21
2
Curiosamente, la rebaja de GitLab es compatible con la [^footnote]sintaxis, incluso antes de que se agregara oficialmente a la documentación
hmijail llora a los renunciantes el
1
@hmijail te estás refiriendo a la nota al pie de GitLab, no a Github como lo preguntaba el OP
Devy
1
@Devy, sí, por eso dije "rebaja de GitLab". Todavía podría ser útil, dado que la implementación de sabor de GitLab parece estar basada en el sabor de GitHub, y que en general Markdown, sus sabores y sus implementaciones son un desastre impuro. Resumen: "por si acaso prueba esto también".
hmijail llora a los reenviados el

Respuestas:

218

GitHub Flavored Markdown no admite notas al pie, pero puede falsificarlo manualmente manually con caracteres Unicode o etiquetas de superíndice, por ejemplo <sup>1</sup>.

¹Por supuesto, esto no es ideal, ya que ahora eres responsable de mantener la numeración de tus notas al pie. Sin embargo, funciona razonablemente bien si solo tiene uno o dos.

Chris
fuente
Gracias, también me gusta cómo otros sitios tienen enlaces de notas al pie en los que se puede hacer clic, pero supongo que esta podría ser la única forma de hacerlo en GitHub.
Enrico Susatyo
66
También puede usar números regulares entre corchetes [1], lo cual es una convención bastante establecida para las notas al pie de texto sin formato en mi experiencia. (Dios mío, ¿por qué no puedo hacer saltos de línea en los comentarios?) [1] Me gustan las notas al pie de Pandoc Mandoc menos el cursor.
Guildenstern
342

Ampliando un poco la respuesta anterior, también puede hacer clic en los enlaces de notas al pie aquí. Primero defina la nota al pie en la parte inferior de esta manera

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

Luego haga referencia a él en otro lugar del documento como este

<sup>[1](#myfootnote1)</sup>
suryasankar
fuente
2
Esta es una buena respuesta intermedia. Mantiene aclarar la intención fuera, la OMI , el exceso de hinchazón para dar formato.
kayleeFrye_onDeck
3
El uso de referencias no numéricas evita el problema mencionado anteriormente de mantener referencias numéricas secuenciales - Example [[TPL]](#TPL)... #### Notes...<a name="TPL">[TPL]</a> footnote template
Randall Whitman
44
No te pierdas la Parte 2 en la respuesta de @ Matteo a continuación. Estaba tan contento con esta respuesta (gracias) que casi no me molesté en desplazarme hacia abajo. . .
Wardw
180

Ampliando aún más las respuestas anteriores, puede agregar un idatributo al enlace de su nota al pie:

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

Luego, dentro de la nota al pie de página, vuelva a vincularla.

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

Esto agregará un poco al final del contenido de su nota al pie, lo que lleva a sus lectores a la línea que contiene el enlace de la nota al pie.

Matteo
fuente
8
Agregando una corrección menor a la respuesta de @ Matteo anterior, tuve que usar en namelugar de iden la llamada a la nota al pie. Es decir <p>Bla bla <sup name="a1">[1](#f1)</sup>
oldfartdeveloper
2
Gracias @oldfartdeveloper. Parece que ambos namey el idtrabajo para archivos README en github.com ... no han probado lo esencial.
Matteo
1
Para aquellos que encuentran estas preguntas y respuestas en alrededor de 2020: esta respuesta funciona en GitHub, ADEMÁS tiene la característica adicional: volver al pie de página-enlace-que-hizo clic . He encontrado una advertencia menor (explicada aquí) , pero esta es LA respuesta afaic.
Seamus
13

No pude lograr que las soluciones de Surya y Matteo funcionen. Por ejemplo, "(# f1)" solo se mostró como texto y no se convirtió en un enlace. Sin embargo, sus soluciones me llevaron a una solución ligeramente diferente. (También formateé la nota al pie y el enlace al superíndice original de forma un poco diferente).

En el cuerpo del texto:

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

Al final del documento:

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

Al hacer clic en el superíndice en la nota al pie, se vuelve al superíndice en el texto original.

Marte
fuente
Interesante. Usaste HTML donde @Matteo usó GFM. Pude lograr que su solución funcionara, pero requirió un poco de violín . ¿Crees que esto es una peculiaridad en el motor de renderizado de GitHub?
Seamus
No tengo idea, @Seamus. Como recuerdo, hubo un poco de prueba y error cuando estaba tratando de resolverlo.
Marte
1
Es una solución inteligente. Y sí, todavía estamos donde estamos hoy: prueba y error :)
Seamus
12

Aunque no sé si está documentado oficialmente en alguna parte, puedes hacer notas de pie de página en Github.

  1. Marque el lugar donde desea insertar el enlace del pie de página con un número entre corchetes, IE [1]

  2. En la parte inferior de la publicación, haga una referencia del marcador numerado y seguido de dos puntos y el enlace, IE [1]: http://www.example.com/link1

Y una vez que lo vea, se representará como enlaces numerados en el cuerpo de la publicación.

Devy
fuente
55
Sin embargo, esto no genera una lista de enlaces al final de su documento. Me gusta en las páginas de Wikipedia.
milosa
¿Debería haber dos puntos después de los corchetes?
sAguinaga
18
Esto no es una nota al pie, es un enlace.
David Moles
El paso #1no funcionó como un enlace en Github Markdown (Dic 2018).
ruhong
7

Para notas cortas, proporcionar un elemento de anclaje con un atributo de título crea una "información sobre herramientas".

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

De lo contrario, para las notas más involucradas, parece que su mejor opción es mantener los enlaces con nombre manualmente.

Rich Traube
fuente
1
Esto no funcionó en una página de rebajas de GitHub Enterprise 2.8
yegeniy
4

Esto funciona para mi:

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

notas al pie: referencia a blablabla <a class="anchor" id="1"></a>

aerijman
fuente
3

Usé una variante de la solución de Mateo. Estoy usando esto en archivos Rmd escritos en Markdown con sabor a github (gfm) para un sitio web con tecnología Jekyll, pero los mismos archivos Rmd se están utilizando para producir archivos PDF en varios contextos. Los archivos Rmd son matemáticos pesados ​​y la matemática se muestra con MathJax en el sitio web. Así que necesitaba una solución que funcionara con gfm que se procesara a través de Jekyll, que funcionara con pandoc-> pdflatex y que sea compatible con MathJax.

fragmento del archivo Rmd (que es 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$es látex, que funciona para mí ya que siempre tengo habilitado MathJax Lo uso para asegurarme de que se muestre correctamente en mis archivos PDF. Pongo mis notas al pie entre corchetes porque el superíndice es confuso si pongo una nota al pie en algunas matemáticas en línea.

Aquí está en acción: https://eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

Estas notas se pueden poner en cualquier lugar del Rmd. Estoy poniendo una lista al final para que sean técnicamente notas finales.

Eli Holmes
fuente
Ligeramente tangencial a la pregunta del OP, pero finalmente me gusta su "solución que funciona con gfm que se procesa a través de Jekyll, funciona con pandoc-> pdflatex y es compatible con MathJax". Buen ejemplo.
boweeb
0

Aquí hay una variación de la respuesta de Eli Holmes que funcionó para mí sin usar látex:

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

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

Ejemplo

Scott Gardner
fuente
0

Aunque la pregunta es sobre Markdown con sabor a GitHub, creo que vale la pena mencionar que a partir de 2013 , GitHub es compatible con AsciiDoc, que tiene esta característica incorporada. Solo necesita cambiar el nombre de su archivo con una .adocextensión y usar:

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

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

Another bold statement.footnote:disclaimer[]

La documentación junto con el resultado final está aquí .

Doron Behar
fuente