En la escritura académica y técnica las referencias y las notas al pie son herramientas comunes para proporcionar contexto.
Markdown tiene algunas capacidades para incluir referencias y notas (aunque sinceramente no es uno de sus puntos más fuertes, pueden seros útiles si escribís este tipo de documentos).
Referencias en Markdown
Las referencias en Markdown son útiles para gestionar enlaces largos o complejos y mejorar la legibilidad del texto.
Markdown permite definir referencias de enlaces en una parte del documento y luego referenciarlas en el texto. En ocasiones esto puede ser es útil para manejar múltiples enlaces y mantener el documento limpio.
Para ello, en primer lugar, definimos la URL con el enlace, en una sección de referencias (por ejemplo): Para ello usamos un identificador entre corchetes, así [1]:
Ahora, podemos referenciar a este enlace en cualquier parte de nuestro documento, usando el indicador. Así,
El concepto de [Markdown][1] es esencial para la documentación técnica.
[1]: https://www.luisllamas.esEn este ejemplo, el texto “Markdown” se enlaza a la URL definida al final del documento usando el identificador [1].
Renderizado, [Markdown][1] quedaría como un enlace normal.
El mejor curso de Markdown que puedes encontrar.
Pero teniendo todas las URL en un único lugar, en lugar de insertadas en el documento. Lo cuál puede ser una ventaja en ciertos tipos de documentos. En otros será una desventaja, la verdad. Así que usarlo o no, dependerá de vuestras necesidades y forma de trabajo.
Notas al pie en Markdown
Las notas al pie permiten añadir información adicional o referencias a tus documentos sin interrumpir el flujo del texto principal. Las notas al pie se renderizan automáticamente al final de la sección o del documento.
Markdown soporta notas al pie a través de una sintaxis específica. Para crear una nota al pie, añadimos la nota con identificador de nota al pie entre corchetes seguido de un signo de adición (^) para insertar una referencia en el texto.
Por otro lado, definimos el contenido de la nota al pie, usando el mismo identificador. Esta definición puede estar en cualquier parte del documento. Normalmente inmediatamente después de su uso, o al final.
Por ejemplo,
Markdown es un lenguaje de marcado ligero[^2] que facilita la escritura de texto con formato.
[^2]: Markdown es un lenguaje creado por John Gruber y Aaron Swartz que se utiliza para formatear texto de manera sencilla y legible.En el renderizado, “Markdown ligero” aparecerá como un enlace que, al hacer clic, llevará al lector a la nota al pie al final del documento.
Markdown es un lenguaje de marcado ligero1 de fácil escritura.
Y en la zona de Notas al pie de página (normalmente al final del capítulo o del documento) aparecerá las notas, por ejemplo así 👇
Footnotes
Markdown es un lenguaje creado por John Gruber y Aaron Swartz que se utiliza para formatear texto de manera sencilla y legible. ↩