El lenguaje de marcado Markdown

Trabajo previo¶

Tutoriales¶

Markdown Tutorial. (s.f.). Recuperado el 1 de marzo de 2024, de https://www.markdowntutorial.com/

Introducción¶

Markdown es un lenguaje de marcado, creado en 2004 por John Gruber y Aaron Swartz. Las “marcas” se utilizan para especificar aspectos de la estructura (ej. títulos, encabezados), estilo (ej. negritas, itálicas) y semántica de un documento. Markdown se caracteriza por ser más sencillo de leer y de usar que otros lenguajes de marcado (ej. Lenguaje de Marcado de Hipertexto o HTML), por lo que se considera un lenguaje de marcado ligero.

Los documentos escritos en Markdown pueden exportarse a una gran variedad de formatos (ej. HTML, DOC, PDF, LaTex) para ser usados en libros, presentaciones o páginas web, entre otros.

Las variaciones de Markdown, también llamadas flavors, son extensiones o modificaciones de la especificación original. Entre las más populares están:

• Python Markdown: para el lenguaje Python.

• GitHub Flavored Markdown: para la plataforma GitHub.

• Pandoc’s Markdown: para el programa Pandoc de conversión entre formatos.

• Quarto: más que un flavor de Markdown es un sistema de publicación de documentos técnicos y científicos que utiliza Markdown. Tiene soporte para incluir y ejecutar código en R, Python, Julia y Observable.

Puede encontrarse una lista más extensa de variaciones de Markdown en Markdown Flavors.

Ejemplo de documento¶

El siguiente es un ejemplo de la sintaxis de Markdown, con marcas para un encabezado, texto en negrita, texto en itálica, un hipervínculo y una imagen.

### Los satélites galileanos

Se llaman **satélites galileanos** los cuatro satélites
de Júpiter descubiertos en 1610 por
[Galileo Galilei](https://es.wikipedia.org/wiki/Galileo_Galilei):
*Ío*, *Europa*, *Ganimedes* y *Calisto*.
Son los más grandes de los satélites de Júpiter,
siendo visibles incluso con telescopios de baja potencia.

![Imagen de Júpiter y los satélites](https://upload.wikimedia.org/wikipedia/commons/thumb/f/fe/Jupiter_and_the_Galilean_Satellites.jpg/168px-Jupiter_and_the_Galilean_Satellites.jpg)

**Figura 1**. Los cuatro satélites galileanos,
en una composición que compara sus tamaños con el tamaño de Júpiter.
En orden descendente, son *Ío*, *Europa*, *Ganimedes* y *Calisto*.

El documento se visualiza de la siguiente manera:

Los satélites galileanos¶

Se llaman satélites galileanos los cuatro satélites de Júpiter descubiertos en 1610 por Galileo Galilei: Ío, Europa, Ganimedes y Calisto. Son los más grandes de los satélites de Júpiter, siendo visibles incluso con telescopios de baja potencia.

Figura 1. Los cuatro satélites galileanos, en una composición que compara sus tamaños con el tamaño de Júpiter. En orden descendente, son Ío, Europa, Ganimedes y Calisto.

El contenido de este ejemplo está basado en Satélite galileano - Wikipedia, la enciclopedia libre.

Sintaxis¶

En esta sección, se explican los principales elementos de sintaxis de Markdown y se muestran sus salidas.

Encabezados¶

Hay seis niveles de encabezados en Markdown, siendo el nivel 1 el de letras más grandes y el 6 el de letras más pequeñas. Se especifican mediante símbolos de numeral (#) antes del texto del encabezado (note el espacio entre el último signo de numeral y el inicio del texto).

Para los encabezados de nivel 1 y nivel 2, existe una sintaxis alterna, con símbolos de igual (=====) o guiones (-----) bajo el texto del encabezado.

Párrafos¶

Los párrafos deben separarse mediante (al menos) una línea en blanco. Un simple cambio de línea no generará un nuevo párrafo.

Cambios de línea¶

Si se requiere un cambio de línea sin una línea en blanco entre párrafos, pueden agregarse dos espacios en blanco al final de la línea ( ) o también un espacio y una barra invertida ( \).

Texto en negrita¶

Hay dos sintaxis para especificar texto en negrita: con dos asteriscos (**) o con dos guiones bajos (__), antes y después del texto.

Texto en itálica¶

Hay dos sintaxis para especificar texto en itálica: con un asterisco (*) o con un guión bajo (_), antes y después del texto.

Texto tachado¶

El texto tachado se especifica con dos guiones (--) antes y después del texto.

Superíndices y subíndices¶

Un superíndice se especifica con un acento circunflejo (^) antes y después del texto que se desea mostrar como superíndice. Un subíndice se especifica con un guión (-) antes y después del texto que se desea mostrar como subíndice.

Líneas horizontales¶

Tres o más asteriscos (***) generan una línea horizontal:

***

También puede generarse con tres o más guiones (---):

---

Citas textuales¶

Se especifican con un símbolo de “mayor que” (>) antes de cada línea.

Enlaces (hipervínculos)¶

Se definen con paréntesis cuadrados ([]) seguidos de paréntesis redondos (()). En los paréntesis cuadrados se coloca (opcionalmente) el texto del enlace y en los redondos la dirección del documento al que conduce el enlace.

Imágenes¶

Se definen con un signo de admiración de cierre (!), paréntesis cuadrados ([]) y paréntesis redondos (()). En los paréntesis cuadrados se coloca (opcionalmente) un texto alternativo de la imagen y en los redondos la dirección de la imagen, ya sea local o remota. Una imagen local se encuentra en la misma computadora en la que está el documento que la referencia, mientras que una imagen remota se encuentra en otra computadora a la que se accede mediante un protocolo de redes como el Protocolo de transferencia de hipertexto (HTTP).

Sintaxis Markdown	Salida


Sugerencia: puede subir imágenes a servicios que permiten subir contenido gratuitamente. Por ejemplo:

• imgur

• GitHub

Markdown no cuenta con sintaxis para especificar el tamaño de una imagen, pero esto puede lograrse con el Lenguaje de marcado de hipertexto (HTML, HyperText Markup Language), su elemento img y sus atributos height y width, los cuales especifican la altura y el ancho de una imagen (las unidades por defecto son pixeles).

Por ejemplo, la expresión HTML:

<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/fe/Jupiter_and_the_Galilean_Satellites.jpg/168px-Jupiter_and_the_Galilean_Satellites.jpg" height="50" alt="Imagen remota">

genera como salida una imagen de 50 pixeles de altura:

Si se usa solo el atributo height, width se ajusta automáticamente y viceversa.

Listas numeradas¶

Se definen con números (1. 2. 3. ...) antes de cada elemento.

Listas no numeradas¶

Se definen con guiones (-) o asteriscos (*) antes de cada elemento.

Notación matemática¶

Las expresiones en notación matemática (ej. ecuaciones) se escriben con base en la sintaxis de LaTeX. Se delimitan (al inicio y al final) con:

• Un símbolo de dólar ($), para ecuaciones dentro de un renglón (inline math).

• Dos símbolos de dólar ($$), para ecuaciones en su propio bloque (display math).

Ejemplo de inline math¶

Sintaxis Markdown

Equivalencia entre masa y energía: \$E = mc^{2}\$

Salida Equivalencia entre masa y energía: $E = mc^{2}$

Ejemplo de display math¶

Sintaxis Markdown

Equivalencia entre masa y energía:

\$\$E = mc^{2}\$\$

Salida Equivalencia entre masa y energía:

Para más detalles sobre la sintaxis de las expresiones matemáticas, se recomienda consultar:

• Writing mathematical expressions - GitHub Docs

• LaTeX/Mathematics

Recursos de interés¶

Daring Fireball: Markdown. (s. f.). Recuperado 25 de marzo de 2023, de https://daringfireball.net/projects/markdown/

LaTeX/Mathematics—Wikibooks, open books for an open world. (s. f.). Recuperado 25 de marzo de 2023, de https://en.wikibooks.org/wiki/LaTeX/Mathematics

Markdown Guide. (s. f.). Recuperado 10 de abril de 2022, de https://www.markdownguide.org/

Writing mathematical expressions. (s. f.). GitHub Docs. Recuperado 25 de marzo de 2023, de https://ghdocs-prod.azurewebsites.net/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions