PureTools

Sintaxis Markdown: Cheatsheet Completo

PureTools Team· 7 min de lectura
Sintaxis Markdown: Cheatsheet Completo

Markdown: Escribe Una Vez, Renderiza en Todas Partes

Markdown es la lengua franca de la documentación de desarrolladores. Archivos README, descripciones de pull request, páginas de Notion, mensajes de Slack y generadores de sitios estáticos todos lo usan. Aprende la sintaxis una vez y puedes escribir contenido formateado en cualquier lugar.

Formato Básico de Texto

**texto en negrita**
*texto en cursiva*
***negrita y cursiva***
~~tachado~~
`código inline`

> Cita — genial para destacar notas importantes
>
> Citas multi-línea también funcionan

Renderiza como: texto en negrita, texto en cursiva, negrita y cursiva, tachado, código inline.

Headings

# Heading 1    (título de la página — usa una vez)
## Heading 2   (secciones principales)
### Heading 3  (subsecciones)
#### Heading 4 (raramente necesario)

Sintaxis alternativa:
Heading 1
=========

Heading 2
---------

Links e Imágenes

[Texto del link](https://example.com)
[Link con título](https://example.com "Texto al pasar el mouse")

![Texto alt](imagen.png)
![Texto alt](imagen.png "Título opcional")


[Google][1]
[GitHub][gh]

[1]: https://google.com
[gh]: https://github.com

Listas

No ordenada:
- Item uno
- Item dos
  - Item anidado (2 espacios de indentación)
  - Otro anidado
- Item tres

Ordenada:
1. Primero
2. Segundo
3. Tercero
   1. Ordenada anidada

Lista de tareas (GitHub):
- [x] Tarea completada
- [ ] Tarea pendiente
- [ ] Otra pendiente

Bloques de Código

Inline: Usa `const x = 1` en tu código.

Bloque cercado con syntax highlighting:
```javascript
function greet(name) {
  return `Hello, ${name}!`;
}
```

```python
def greet(name: str) -> str:
    return f"Hello, {name}!"
```

```bash
curl -X POST https://api.example.com/data \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'
```

Tablas

| Feature       | Markdown | HTML    |
|---------------|----------|---------|
| Aprendizaje   | Fácil    | Medio   |
| Legibilidad   | Alta     | Baja    |
| Flexibilidad  | Media    | Alta    |

Alineación:
| Izquierda | Centro | Derecha |
|:----------|:------:|--------:|
| I         |   C    |       D |

Líneas Horizontales

Tres o más guiones, asteriscos o underscores:

---
***
___

GitHub-Flavored Markdown (GFM)

GitHub agrega varias extensiones:

URLs autolinked: https://github.com

Mencionar usuarios: @username
Referenciar issues: #123
Referenciar commits: abc1234

Emoji: :rocket: :tada: :bug:

Notas al pie:
Esto tiene una nota[^1].

[^1]: Este es el contenido de la nota al pie.

Alertas (desde 2023):
> [!NOTE]
> Información útil.

> [!WARNING]
> Contenido crítico.

> [!TIP]
> Consejo útil.

Escapando Caracteres Especiales

\*no cursiva\*
\# no es heading
\[no es link\]
\`no es código\`

Buenas Prácticas para READMEs

  • Empieza con un título claro y descripción de una línea de lo que hace el proyecto
  • Agrega badges (estado del build, versión npm, licencia) justo después del título
  • Incluye una sección Quick Start con comandos de install + run copiables
  • Usa headings para crear estructura escaneable: Instalación, Uso, API, Contribuyendo
  • Agrega ejemplos de código con el lenguaje especificado para syntax highlighting

Convierte tu Markdown: Markdown a HTML — pega Markdown, obtén HTML limpio instantáneamente.

← Volver al blog