Cada elemento de Markdown con un ejemplo que puedes editar y ver renderizado al instante: saltos de línea, enlaces, tablas, casillas, notas al pie, bloques de código y alertas de GitHub, además de una plantilla de README.
Markdown da formato al texto plano con unos pocos símbolos: # para los títulos, **dos asteriscos** para la negrita, [texto](dirección) para los enlaces, - para las listas con viñetas y tres comillas invertidas para los bloques de código. Puedes editar cada ejemplo de abajo, y la vista previa de al lado se actualiza mientras escribes, así que puedes probar una sintaxis antes de usarla.
Los cinco que más vas a usar
Dieciocho ejemplos en vivo que cubren todo, desde los títulos hasta las notas al pie y las alertas de GitHub, una tabla con las diferencias entre GitHub y CommonMark estándar, una plantilla de README y un editor completo al final de la página.
Termina la línea con dos espacios o una barra invertida y pulsa Enter. Un Enter normal se trata como un espacio y las líneas se juntan. Si quieres un párrafo nuevo en vez de un salto de línea, deja una línea en blanco.
Empieza un elemento de lista con - [ ] para una casilla vacía o con - [x] para una marcada. Las listas de tareas forman parte de GitHub Flavored Markdown, así que funcionan en GitHub, GitLab y la mayoría de las apps de notas, pero no en CommonMark estricto.
Escribe la fila de encabezado con barras verticales entre las columnas, después una fila de guiones y luego una línea por cada fila. Las columnas no tienen que estar alineadas en el código fuente. Añade dos puntos en la fila de guiones para alinear una columna a la izquierda, a la derecha o al centro.
Markdown es la sintaxis original de 2004, que dejaba muchos casos sin definir. CommonMark es una especificación precisa de esa sintaxis básica. GitHub Flavored Markdown es CommonMark más tablas, listas de tareas, tachado, enlaces automáticos y notas al pie, y es lo que sigue la mayoría de las herramientas para desarrolladores.
La mayoría de los renderizadores lo permiten, así que las etiquetas details y summary o una imagen centrada son habituales en los README. GitHub elimina los scripts, los estilos y algunos atributos por seguridad. Las vistas previas de esta página no renderizan HTML sin procesar, así que lo muestran como texto.
De uno a seis signos #, y luego un espacio. Usa un solo título con # por documento.
Los guiones bajos (__negrita__, _cursiva_) también funcionan, pero no en mitad de una palabra.
Dos virgulillas a cada lado. Forma parte de GitHub Flavored Markdown, no del núcleo de CommonMark.
Un solo Enter no corta la línea. Termínala con dos espacios o una barra invertida, o deja una línea en blanco para un párrafo nuevo.
El texto entre corchetes y la dirección entre paréntesis. Los signos de menor y mayor hacen que una dirección suelta sea clicable.
Mantiene las direcciones largas fuera del texto. Las definiciones pueden ir en cualquier parte y no se muestran.
Como un enlace con ! delante. El texto entre corchetes es el texto alternativo que leen los lectores de pantalla.
Usa -, * o + para las viñetas y 1. para los números. Sangra con entre dos y cuatro espacios para anidar.
Un espacio entre los corchetes es una casilla sin marcar; una x, una marcada. En GitHub puedes marcarlas en las issues.
Empieza cada línea con >. Una línea que solo tenga > mantiene los párrafos en una misma cita.
Las comillas invertidas mantienen el texto tal cual se escribe. Para mostrar una comilla invertida, rodéalo con dos: `` a`b ``.
Tres comillas invertidas antes y después. La palabra que sigue a la apertura indica el lenguaje para el resaltado.
Las barras verticales separan las columnas; la fila de guiones es obligatoria. Los dos puntos fijan la alineación: izquierda, derecha o centro.
Tres o más guiones, asteriscos o guiones bajos en su propia línea. Deja líneas en blanco alrededor de los guiones para que no se interpreten como el subrayado de un título.
La nota se reúne al final del documento con un enlace de vuelta.
Una barra invertida delante de * _ # [ ] ` y caracteres parecidos los muestra como texto plano.
GitHub convierte las direcciones sueltas en enlaces. CommonMark estricto necesita los signos de menor y mayor.
GitHub las muestra como cajas de colores; otras apps muestran una cita normal, como hace aquí la vista previa.
La sintaxis de Markdown y dónde funciona
En qué se diferencia GitHub Flavored Markdown de CommonMark
En todas partes
GitHub y la mayoría de las apps
Solo GitHub
Markdown (edítame)
Vista previa
Copiar
Restablecer
La sintaxis de un vistazo
Cada elemento, en vivo
GitHub frente a CommonMark
Plantilla de README
Copiar plantilla
Abrir en el editor
Editor completo
Markdown
Copiar Markdown
{n} palabras. No se guarda ni se envía nada.
Empieza gratis · Sin tarjeta de crédito