Guía rápida de como escribir en Markdown.
Markdown está basado en HTML, así que cualquier archivo HTML es Markdown válido, lo que significa que podemos usar elementos HTML en su interior. Por ejemplo, si se usa un comentario, el texto no aparecerá en el documento final. Sin embargo, dentro de un elemento HTML no podrás continuar usando sintaxis Markdown dentro de él.
La implementación de Markdown cambia de acuerdo al parser (el programa que transforma el Markdown a HTML). Esta guía servirá para clarificar cuales características son universales y cuales son específicas de cada uno.
Estilo y caracteres
- Cursiva: Uso de
*
o_
alrededor de la palabra. - Negrita: Uso de
**
o__
alrededor de la palabra. - Ambos estilos: Uso de
***
,___
,*__
,**_
y demás variantes alrededor de la palabra. Código
: Uso de ` alrededor de la palabra.Tachado: Uso de~~
alrededor de la palabra.- Caracteres especiales: Uso de \ antes del carácter.
- Salto de
<br>
: Uso de---
o***
(se admite con espacios en el medio).
Otros caracteres especiales
Markdown, al poder escribir HTML, podemos usar la sintaxis propia de este para insertar más caracteres. A continuación hay algunos ejemplos:
- Flecha derecha (
→
): →
Aquí puedes encontrar una buena lista con sus correspondientes codificaciones y formato).
Enlaces
Texto entre
[]
y el enlace entre()
.Cuando estos enlaces son muy largos, podemos darles una etiqueta (o incluso no poner nada) la que luego anidaremos con el enlace en cuestión.
Si no queremos que cambie el texto, simplemente lo situamos entre
<>
.Se le puede añadir una tarjetita de información entre los paréntesis con
""
.También funciona con rutas relativas a otros archivos (e.g.:
/documentation/LICENSE.md
).Incluso podemos poner enlaces en el mismo documento, en lugar de dar una dirección escribimos un
ID
(precedido de un#
) que referencie a otra parte del documento donde incluimos una etiqueta<a id= ""></a>
.
Imágenes o GIFs
Con este mismo método de los enlaces, tanto usando URLs como direcciones a
archivos, podemos añadir imágenes a nuestro documento, simplemente añadiendo
!
delante.
Párrafos
Títulos
- Uso de
#
tantas veces como pequeño sea el título. Es decir:#
:<h1>
##
:<h2>
###
:<h3>
####
:<h4>
- …
- Uso de
=
a modo de subrayado para títulos grandes y-
para títulos más pequeños.
Nuevo párrafo:
- Doble ENTER: El simple se ignora, y si añades más de 2 también.
- Poner
\
al final: Esto separará el párrafo sin tener que darle dos veces. - Etiqueta br: salto de HTML.
Listas
- Uso de
-
,+
o*
para listas no enumeradas. - Uso de números (
1.
,2.
,3.
, …) para listas numeradas. - Para hacer sublistas añadir identación (4 espacios generalmente).
Además, se pueden alternar con una lista no enumerada con una sublista desordenada y viceversa.
Citas
- Uso de
>
(se puede añadir>
adicionales y crear citas anidadas).
Código
- Uso de
~~~
para declarar un bloque de código. - Uso de ``` para declarar un bloque de código (GitHub Flavored Markdown).
- Uso de identación (4 espacios generalmente).
Tablas
Solamente disponible en GitHub Flavored Markdown.
- Los elementos se sitúan entre
|
.
Estilo
Nota: se le puede añadir más guiones para separar los elementos.
- Centrado:
:-:
- Izquierda:
:-
- Derecha:
-:
Ejemplos
Nota: Mejor ver esta sección en el repositorio
Texto normal
Texto en cursiva
Otro texto en cursiva
Texto en negrita
Otro texto en negrita
Ahora soy un texto con ambos estilos
Tengo los dos estilos otra vez
Vaya, otra vez
Esto resulta ser un pedazo de código
¿Por qué estoy tachado?
Aquí algunos caracteres raros: ` * \ _
Enlace a Google
<www.google.com>
Otro enlace a Google
Enlace al final del documento
h1
h2
h3
h4
h5
h6
Otro h1
Otro h2
Esto es un párrafo. Sigo estando en el mismo párrafo.
Ahora estoy en otro párrafo.
Y ahora en otro.
- Elemento 1 de una lista
- Elemento 2 de una lista
- Subelemento 1 de la lista
- Subelemento 2 de la lista
- Subelemento 3 de la lista
- Elemento 3 de una lista
- Elemento 1 de una lista ordenada
- Elemento 2 de una lista ordenada
- Subelemento 1 de la lista ordenada
- Subelemento 2 de la lista ordenada
- Subelemento 3 de la lista ordenada
- Elemento 3 de una lista ordenada
Esto es una cita
Esto es una subcita
1Bloque de código 1
1Bloque de código 2
Bloque de código 3
Código con identación
Col1 | Col2 | Col3 |
---|---|---|
Centrado | Derecha | Izquierda |
Columna 1 | Columna 2 | Columna 3 |
---|---|---|
Texto un poco largo | Texto | Esto es un texto muy más largo que el otro |
- Checkbox marcado
- Checkbox vacío