GitHub Flavored Markdown (GFM): la guía completa de sintaxis

GitHub Flavored Markdown —casi siempre abreviado como GFM— es el dialecto de Markdown popularizado por GitHub. Toma el Markdown estándar de CommonMark y le añade una serie de funciones que hacen que la escritura diaria sea muchísimo más útil: tablas, listas de tareas, tachado, autolinks y algunas mejoras de análisis sintáctico. Esta guía cubre todas las funciones de GFM con ejemplos que puedes copiar y pegar.

GFM es un superconjunto estricto de CommonMark. Todo lo que sea válido en Markdown estándar es válido en GFM; GFM simplemente añade más.

Lo que GFM añade al Markdown estándar

La buena noticia: si tu herramienta es compatible con GFM (el conversor de este sitio lo es), obtienes todo lo anterior de forma gratuita.

Tablas

Las tablas son la función estrella de GFM. Se construyen con barras verticales | y una fila separadora de guiones ---:

| Formato | Extensión | Mejor para |
| --- | --- | --- |
| Word | `.docx` | Documentos de empresa |
| PDF | `.pdf` | Impresión y archivo |
| HTML | `.html` | Páginas web |

Puedes controlar la alineación de las columnas con dos puntos en la fila separadora:

Algunas reglas a recordar:

• Las celdas pueden contener formato en línea, enlaces y código en línea.
• Las celdas no pueden contener elementos de bloque como títulos, citas en bloque o tablas anidadas.
• Las celdas combinadas no son compatibles; en Markdown no existe colspan/rowspan.
• Las barras verticales iniciales y finales son opcionales, pero incluirlas mantiene las tablas legibles.

Las tablas anchas se desbordan en pantallas pequeñas. Si exportas a PDF o Word, plantea dividir las tablas muy anchas en dos más estrechas.

Listas de tareas

Las listas de tareas convierten las listas con viñetas en casillas interactivas en GitHub, y se renderizan como casillas (o marcadores de lista claros) en la mayoría de los visualizadores de GFM:

- [x] Pega tu Markdown
- [ ] Previsualiza el formato
- [ ] Exporta como .docx

Que se renderiza así:

• Pega tu Markdown
• Previsualiza el formato
• Exporta como .docx

Las listas de tareas funcionan tanto en listas con viñetas (-) como en listas numeradas (1.), y se pueden anidar.

Tachado

Encierra el texto entre dos virgulillas para tacharlo:

Esta función está ~~obsoleta~~ en desuso.

Se renderiza así: Esta función está obsoleta en desuso.

Autolinks y URLs simples

GFM convierte automáticamente las URLs y direcciones de correo electrónico simples en enlaces clicables:

Visita https://markdowntoword.org para un conversor gratuito.

Para enlaces explícitos y legibles, prefiere la sintaxis estándar:

[Markdown to Word](https://markdowntoword.org)

También puedes envolver una URL entre corchetes angulares para forzar un enlace incluso cuando GFM no la convertiría automáticamente: <https://example.com>.

Bloques de código y resaltado de sintaxis

Los bloques cercados pueden incluir una etiqueta de lenguaje después de la cerca inicial. GitHub la utiliza para colorear la sintaxis, pero la etiqueta por sí sola no añade colores en todos los visualizadores GFM. Este sitio muestra código monoespaciado sin colores de sintaxis:

```js
function convert(md) {
  return render(md);
}
```

Etiquetas de lenguaje habituales:

Cuando necesites mostrar una cerca dentro de un bloque de código, usa cuatro acentos inversos para la cerca exterior (como se muestra arriba) o usa cercas de virgulillas (~~~).

Listas y saltos de línea

GFM aclara algunos comportamientos que en Markdown estándar suelen confundir a la gente:

• Una línea en blanco antes de una lista mejora la legibilidad. Algunas listas pueden interrumpir un párrafo sin ella; una lista numerada que interrumpe un párrafo debe empezar por 1.
• Un salto de línea suave (un único salto de línea) dentro de un párrafo se renderiza como un espacio en la mayoría de los contextos; usa dos espacios al final o una barra invertida \ al final de la línea para un salto de línea duro.
• Las listas numeradas no tienen que empezar en 1 en el código fuente, pero GFM las renumerará secuencialmente al renderizar.

HTML no permitido y HTML en bruto

La especificación GFM filtra algunas etiquetas HTML, pero no sustituye a un saneador de seguridad completo. GitHub aplica procesamiento adicional. Este sitio elimina por separado HTML ejecutable, esquemas URL peligrosos y estilos en línea arbitrarios, y permite determinadas etiquetas estructurales como <sub> y <sup>. Las imágenes remotas todavía pueden realizar solicitudes de red. Consulta la especificación GFM.

Todo junto

Aquí tienes un pequeño documento que ejercita varias funciones de GFM a la vez:

## Notas de la versión v2.0

- [x] Añadir exportación de **tabla** a Word
- [x] Soportar el renderizado de ~~tachado~~
- [ ] Crear autolink de URLs simples en PDF

| Función | Estado |
| :--- | :---: |
| Tablas | ✓ |
| Listas de tareas | ✓ |

Consulta el [changelog](https://example.com/changelog) para más detalles.

Convertir GFM a Word, PDF y HTML

Este sitio convierte las estructuras GFM habituales de la siguiente manera:

• A Word — tablas editables, elementos de lista con [x] o [ ] como texto y código monoespaciado. Puede ser necesario ajustar la alineación de las columnas en Word.
• A PDF — páginas basadas en imágenes con títulos, tablas y código monoespaciado. No hay una capa de texto buscable ni enlaces clicables.
• A HTML — HTML estructurado para un sitio web o CMS. El coloreado de sintaxis requiere un resaltador adicional en el destino.

Conclusión

GitHub Flavored Markdown ofrece tablas, listas de tareas, tachado, autolinks y un manejo más seguro del HTML por encima del Markdown estándar: todo lo que la mayoría de los escritores necesitan en realidad. Una vez que conoces estas funciones, puedes crear documentos más completos sin salir de tu editor de texto. ¿Listo para convertir GFM en un documento pulido? prueba el conversor Markdown to Word y exporta tu próximo archivo a .docx, PDF o HTML.