Cómo usar el editor de Markdown
- Escribe o pega Markdown en el editor de la izquierda.
- Mira cómo se actualiza la vista previa en directo mientras escribes, renderizada con Markdown al estilo de GitHub (GFM).
- Haz clic en Copiar HTML para copiar el HTML generado y usarlo en una web, un CMS o un correo electrónico.
- O copia el propio Markdown para un README, una issue, una pull request o una página de documentación.
El renderizado se hace en tu navegador, y tu texto no se sube ni se guarda. El HTML renderizado se sanea, así que los scripts y los atributos peligrosos del contenido pegado se eliminan antes de mostrar la vista previa.
¿Qué es Markdown?
Markdown es un lenguaje de marcado ligero creado por John Gruber en 2004. Usa signos de puntuación de texto plano para dar formato: # para los encabezados, * o _ para el énfasis y - para las listas. El código fuente se puede leer como texto plano, y un renderizador lo convierte en HTML.
La descripción original dejaba sin definir muchos casos límite, así que las implementaciones no coincidían. CommonMark es una especificación detallada que resuelve esas ambigüedades, y el Markdown al estilo de GitHub (GFM) es un superconjunto de CommonMark que añade funciones que los desarrolladores usan a diario:
| Función de GFM | Sintaxis |
|---|---|
| Tablas | | Name | Value | con una fila separadora |---|---| |
| Listas de tareas | - [ ] todo y - [x] done |
| Tachado | ~~removed~~ |
| Enlaces automáticos | Las URL sueltas como https://example.com se convierten en enlaces |
| Bloques de código delimitados | Tres comillas invertidas, seguidas opcionalmente del nombre de un lenguaje |
Guía rápida de Markdown
# Encabezado 1
## Encabezado 2
**negrita**, *cursiva*, `código en línea`
- Elemento de lista
- Elemento anidado (sangría de dos espacios)
1. Elemento numerado
[Texto del enlace](https://example.com)
> Una cita
```python
print("código delimitado con un lenguaje")
```Problemas habituales de Markdown y cómo solucionarlos
El encabezado no se muestra. CommonMark exige un espacio después de las almohadillas. #Title es texto normal; # Title es un encabezado.
Las líneas se unen en un solo párrafo. Un salto de línea simple dentro de un párrafo se trata como un espacio. Deja una línea en blanco para empezar un párrafo nuevo, o termina una línea con dos espacios o una barra invertida para forzar un salto de línea. (Los comentarios de GitHub tratan los saltos de línea simples de forma distinta a los archivos README, lo que suele causar confusión).
Una lista o un bloque de código se cortan antes de tiempo. El contenido que pertenece a un elemento de lista debe tener sangría para alinearse con el texto del elemento. Para incluir código dentro de una lista, aplica sangría a todo el bloque delimitado:
1. Instala el paquete:
```bash
npm install example
```
2. Ejecútalo.La tabla no se muestra. Una tabla GFM necesita una fila de encabezado, una fila separadora con al menos tres guiones por columna y, normalmente, una línea en blanco antes. Usa dos puntos en la fila separadora (:---, :---:, ---:) para alinear las columnas.
Formato no deseado. Caracteres como *, _ y # pueden activar un formato. Escápalos con una barra invertida, por ejemplo \*not italic\*, o enciérralos entre comillas invertidas.
Consejos y buenas prácticas
- Añade siempre un lenguaje después de las comillas invertidas de apertura para que los bloques de código tengan resaltado de sintaxis donde sea compatible.
- Escribe un texto alternativo útil para las imágenes; lo usan los lectores de pantalla y se muestra cuando la imagen no carga.
- En documentos largos, escribe una frase por línea; Markdown las une en párrafos y los diffs quedan mucho más limpios.
- Pega primero los ejemplos JSON o YAML en el formateador de JSON o el formateador de YAML, para que los bloques de código de tu documentación sean válidos y estén ordenados.
- Si pegas el HTML generado en una página web, pásalo por el formateador de HTML para darle una sangría limpia.
Preguntas frecuentes
¿Qué diferencia hay entre Markdown y Markdown al estilo de GitHub?
GFM es un superconjunto del Markdown de CommonMark definido por GitHub. Añade tablas, listas de tareas, tachado, enlaces automáticos ampliados y algunas restricciones sobre el HTML sin procesar. La mayoría de los README escritos para GitHub se ven igual aquí.
¿Puedo usar HTML dentro de Markdown?
Sí, Markdown admite HTML en línea. Por seguridad, la vista previa sanea el resultado, así que se eliminan etiquetas como <script>, los atributos de gestión de eventos como onclick y los enlaces javascript:.
¿Por qué mi Markdown se ve distinto en otra web?
Cada plataforma usa su propia variante de Markdown y sus propias hojas de estilo. La sintaxis básica (encabezados, énfasis, listas, enlaces, código) es la misma, pero las tablas, los saltos de línea y las extensiones como las notas al pie o las fórmulas matemáticas varían de un renderizador a otro.
¿Cómo convierto Markdown a HTML?
Escribe o pega tu Markdown, revisa la vista previa y luego haz clic en Copiar HTML. El resultado es HTML semántico sencillo (encabezados, párrafos, listas, tablas) sin estilos, así que adopta el CSS de la página en la que lo pegues.
Actualizado