El GitHub Flavored Markdown (GFM) es una extensión del Markdown clásico creada por GitHub para mejorar la documentación técnica dentro de los repositorios.
Incluye soporte adicional que no existía en la versión original de John Gruber (2004). Muchas de estas características hoy son estándar en plataformas como GitHub, GitLab, Bitbucket, Obsidian y VS Code.
Entre las extensiones más importantes están:
Las listas de tareas son una mejora de las listas no ordenadas. Cada ítem puede mostrarse como una casilla de verificación (checkbox), marcada o no marcada.
Sintaxis
- [ ] Tarea pendiente
- [x] Tarea completada
Renderizado
👉 Notas:
[ ]
casilla vacía (pendiente).[x]
casilla marcada (completada).Ejemplo práctico
# Lista de tareas
## Preparación
- [x] Instalar dependencias
- [ ] Configurar base de datos
- [ ] Probar la aplicación
Renderizado:
👉 En GitHub, las casillas pueden ser interactivas desde la interfaz.
Otra mejora de GFM es el soporte para resaltado en bloques de código al especificar el lenguaje tras los backticks.
Ejemplo en Python
```python
def saludo():
print("Hola desde Markdown GFM")
```
Renderizado con resaltado:
def saludo():
print("Hola desde Markdown GFM")
Ejemplo en JavaScript
```javascript
function sumar(a, b) {
return a + b;
}
console.log(sumar(3, 4));
```
Renderizado:
function sumar(a, b) {
return a + b;
}
console.log(sumar(3, 4));
Ejemplo en JSON
```json
{
"nombre": "Ana",
"edad": 25,
"activo": true
}
```
Renderizado:
{
"nombre": "Ana",
"edad": 25,
"activo": true
}
Lenguajes soportados
GitHub soporta más de 200 lenguajes (Python, JavaScript, Java, C/C++, C#, PHP, Go, Ruby, HTML, CSS, JSON, YAML, SQL, Bash, Dockerfile, Markdown, entre otros).
https://www.github.com
Renderizado: https://www.github.com
:smile:
que GitHub muestra como 😄.# Ejemplo de GFM
## Lista de tareas
- [x] Escribir introducción
- [ ] Completar ejemplos
- [ ] Revisar ortografía
## Bloque de código con resaltado
```bash
echo "Hola desde GitHub Flavored Markdown"
```
## JSON con resaltado
```json
{
"usuario": "juanperez",
"activo": true,
"rol": "admin"
}
```
## Enlace automático
https://www.github.com
Renderizado:
echo "Hola desde GitHub Flavored Markdown"
{
"usuario": "juanperez",
"activo": true,
"rol": "admin"
}
GitHub Flavored Markdown (GFM) amplía el Markdown clásico con listas de tareas, resaltado extendido y extras como enlaces automáticos, tablas mejoradas y emojis. Es el estándar de facto en proyectos de software por combinar simplicidad con potencia para documentación técnica.
¿Listo para practicar lo aprendido? Visita el visor de Markdown y pon en práctica los conceptos.