Lección 3
GitHub Flavored Markdown en español
Trabaja con tablas GFM, bloques de código delimitados, listas de tareas y otras extensiones compatibles con GitHub.
GitHub Flavored Markdown (GFM) extiende Markdown básico con funciones en las que confían los desarrolladores en README e incidencias.
Tablas
| Tool | Purpose |
| --- | --- |
| JSON Formatter | Validate API payloads |
| Markdown Preview | Draft README files |
Las tablas son útiles para listas de funciones, matrices de compatibilidad y comparaciones rápidas.
Bloques de código delimitados con etiquetas de lenguaje
```json
{
"status": "ok"
}
```
Las etiquetas de lenguaje ayudan a los renderizadores a aplicar estilo de sintaxis y ayudan a los lectores a entender el tipo de fragmento de inmediato.
Listas de tareas
- [x] add endpoint
- [ ] update docs
- [ ] add regression test
Las listas de tareas son habituales en plantillas de incidencias y listas de comprobación de PR.
Tachado
~~deprecated option~~
Útil al documentar claves de configuración eliminadas o campos de API obsoletos.
Lo que GFM no garantiza en todas partes
No todo renderizador de Markdown soporta cada función GFM. Antes de publicar:
- confirma que tu plataforma objetivo soporta tablas y listas de tareas
- evita extensiones exóticas si el documento debe renderizarse en múltiples sistemas
Conclusión clave
GFM es el dialecto detrás de la mayoría del contenido de README e incidencias de GitHub. Si escribes primero para GitHub, tablas, bloques de código delimitados y listas de tareas suelen ser opciones seguras.
Previsualiza muestras GFM en la herramienta Vista previa Markdown / Markdown a HTML antes de hacer commit de un README o plantilla de incidencia.