¿Qué es Markdown?

Según la definición de Wikipedia:

«Markdown es un lenguaje de marcado ligero creado por John Gruber y Aaron Swartz que trata de conseguir la máxima legibilidad y facilidad de publicación…, inspirándose en muchas convenciones existentes para marcar mensajes de correo electrónico usando texto plano».

Básicamente, Markdown (en adelante md) permite que aun sin saber nada de lenguaje html, podamos publicar en la web, así como en una gran variedad de formatos: odt, docx, pdf, tex… Escribir en md tiene, entonces, al menos tres ventajas:

1. Es sencillo de escribir.
2. Es legible tanto para seres humanos como para máquinas.
3. Permite publicar documentos correctamente estructurados y en múltiples formatos, desde un solo archivo de texto simple.

Eso sí: no hay una implementación estándar. Distintos proyectos han adaptado md a sus propios objetivos. Así, lo que funciona en un lugar no siempre funciona en otro. Pero no te preocupes: hay una base común, que es la que leerás a continuación. Aprenderla te tomará alrededor de una hora de estudio o menos. Valdrá la pena, porque te ahorrará en adelante, a medida que te familiarices, infinidad de horas de trabajo de escritura y formato.

Esta guía es todavía mejorable. Pero tiene la utilidad de que te permite leer su archivo de origen (en texto plano) y, si deseas, hacer pruebas desde ahí mismo y modificarlo de acuerdo con tus necesidades. En este directorio comprimido encontrarás los archivos que necesitas:

https://www.solounpocoaqui.com/recursos/laboratorio-markdown.zip

Como sea, te invito a revisar otras fuentes. Por su sencillez, recomiendo las dos en que me basé:

• Daring Fireball (en inglés).

• Tutorial de Markdown, por ~hora_z (en español).

Dos notas previas

UNO. Cuando escribimos en texto plano, cada párrafo debe estar delimitado con una línea en blanco al final. Sin ella, todas las líneas contiguas serán tomadas como una sola. De esa manera, esto:

*Lorem ipsum dolor sit amet, 
consectetuer adipiscing elit. 
Ut a sapien. Aliquam aliquet 
purus molestie dolor. Integer 
quis eros ut erat posuere dictum. 
Curabitur dignissim.*
 

Será interpretado como una sola línea larga, así:

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut a sapien. Aliquam aliquet purus molestie dolor. Integer quis eros ut erat posuere dictum. Curabitur dignissi.

No obstante, si deseas introducir saltos de línea, como en el ejemplo anterior (o como cuando citas o escribes un poema), sólo debes añadir, con la barra espaciadora, dos espacios en blanco antes de cada salto, así:

Nada se pierde con vivir, tenemos
todo el tiempo del tiempo por delante
para ser el vacío que somos en el fondo.

—Enrique Lihn, «Monólogo del padre con su hijo de meses».

DOS. Sin importar cuántas líneas en blanco añadas, sólo será interpretada una línea.

Sintaxis Markdown

Títulos

# Título 1
## Título 2
### Título 3
#### Título 4
##### Título 5
###### Título 6

El resultado será:

Puedes escribir los dos primeros también así:

Título 1
========

Título 2
---------

Énfasis

*cursiva* / **negrita** / ***cursiva y negrita***  
_cursiva_ / __negrita__ / ___cursiva y negrita___  
~~texto tachado~~  
`texto monoespaciado`

Será interpretado así:

cursiva / negrita / cursiva y negrita
cursiva / negrita / cursiva y negrita
texto tachado
texto monoespaciado

Cita

> Bloque de cita. Primer nivel de indentación.

> > Otro nivel de indentación.

> Regreso al primer nivel.

Será interpretado así:

Bloque de cita. Primer nivel de indentación.

Otro nivel de indentación.

Regreso al primer nivel.

Listas

Listas numeradas como ésta:

1. Frutas
   + Rojas
     - Manzana
     - Cereza
2. Verduras
3. Golosinas

Serán interpretadas así:

1. Frutas
   • Rojas
     • Manzana
     • Cereza
2. Verduras
3. Golosinas

Y listas viñetadas:

* Frutas
  + Rojas:
    - Manzana
    - Cereza
* Verduras
* Golosinas

Así:

• Frutas
  • Rojas:
    • Manzana
    • Cereza
• Verduras
• Golosinas

También es posible crear una lista de tareas. Por ejemplo:

• Tarea terminada
  • subtarea terminada
  • subtarea terminada
• Tarea pendiente
  • subtarea pendiente

Se hace así:

+ [x] Tarea terminada
  - [x] subtarea terminada
  - [x] subtarea terminada
+ [ ] Tarea pendiente
  - [ ] subtarea pendiente
 

Definiciones

Usa este formato para producir definiciones (las negritas no son necesarias):

**Concepto** 
: Definición tan breve o larga como desees. El formato de indentado será el de un párrafo francés.
 

Resultado:

Concepto

Definición tan breve o larga como desees. El formato de indentado será el de un párrafo francés.

Notas al pie

Las notas al pie se indican con acento circunflejo (caracter unicode 005e).¹ Así:

Un texto con nota al pie.[^1]
    

Y luego, en cualquier lugar del archivo (al final, por ejemplo), escribe la nota al pie:

[^1]: Mi nota al pie.
    

Imágenes

![Alt text](ruta/a/la/imagen.jpg "Título")

El texto alternativo (alt text) es la descripción de la imagen, útil además para ser leído por el software de accesibilidad que usan personas ciegas o con alguna debilidad visual. Aunque, si prefieres, puedes dejar vacío el espacio entre corchetes.

El “Título” es opcional. Se trata del texto que aparece en las páginas web al pasar el ratón por encima de la imagen.

Enlaces

Modo 1

Mostrar un enlace:

Visita <https://texto-plano.xyz>.
    

Se vería así:

Visita https://texto-plano.xyz.

Modo 2:

Ocultar el enlace con otro texto:

Te invito a escuchar 
[el podcast de Texto-Plano](https://podcast.texto-plano.xyz).
    

Daría como resultado:

Te invito a escuchar el podcast de Texto-Plano.

Aquí, además de una URL o la ubicación de un archivo, podrías enlazar también el título de una sección de tu documento. Sólo cuida de a) no escribir mayúsculas, b) sustituir los espacios en blanco de un título por guiones simples (-) y c) empezar siempre por el signo #. Ejemplo:

Volvamos al título de este documento llamado [MODO 1.](#modo-1)
    

Daría como resultado:

Volvamos al título llamado MODO 1.

Modo 3:

Es lo mismo que el anterior. Sólo que puedes darle un nombre a la referencia para no interrumpir la lectura en el archivo de escritura con un enlace muy largo. Funciona así:

[texto mostrado][referencia]
    

Después, en cualquier lugar del archivo, indica así la referencia:

[referencia]: ruta/al/contenido
        

Ejemplo:

Texto-Plano tiene, además, su propio y orgulloso 
[insta hecho con palos y alambre (clic)][insta-tp].

[insta-tp]: https://img.texto-plano.xyz 
    

Se interpretará así:

Texto-Plano tiene, además, su propio y orgulloso insta hecho con palos y alambre (clic).

Código

Hay varias maneras de insertar líneas de código (o texto plano). Dentro de un párrafo, con un acento grave al comienzo y otro al final de las palabras que deseamos en texto plano. Así:

Insertar `texto plano` dentro de un párrafo.

Otra forma es colocar tres virgulillas (~) al comienzo y final de un bloque:

~~~
Mis líneas de código
o texto simple
van aquí   :)
~~~

El resultado sería el mismo si, en vez de las virgulillas, añadieras cuatro espacios en blanco antes de cada línea de código.

Omitir interpretación de caracteres

Como has visto, markdown reserva algunos caracteres para crear etiquetas (títulos, negritas, cursivas…). Se les llama «caracteres de escape» y deben ser escapados, si queremos que no sean interpretados como markdown. Para hacerlo, basta con anteponerles una diagonal inversa (caracter unicode 005c). Por ejemplo:

*Aunque hay un asterisco al principio y otro al final, esto no aparecerá en cursiva, porque añadí una diagonal inversa (\) antes de cada asterisco*

CARACTERES QUE DEBEN SER ESCAPADOS

\   diagonal inversa
`   acento grave
*   asterisco
_   guion bajo
{}  llaves
[]  corchetes (sólo cuando van unidos a paréntesis o corchetes)
()  paréntesis (sólo cuando van unidos a corchetes)
#   numeral
+   más
-   guion
!   signo de exclamación de cierre (sólo cuando aparece al inicio)
 

Software necesario

Cualquier editor de texto de que dispongas en tu computadora vale para escribir en md: Notepad++, Gedit, Nano, Vim, Emacs… De hecho, excepto por unos pocos caracteres, podrías escribir md con una máquina de escribir y, más aún, a mano, con lápiz y papel.

Ahora bien, tanto si necesitas exportar tu archivo md a cualquier otro de salida (docx, odt, pdf, html, epub…), como si deseas ver el resultado a medida que escribes (aunque no es necesario), necesitarás algún software extra. Hay varios. Échale un ojo a estos recursos útiles.

Otra opción es que aprendas a usar Pandoc. Es probable que la mayor parte de las veces el único comando que necesites teclear para generar el tipo de archivo que requieras sea éste:

pandoc entrada.txt -o salida.html

Y listo. Cada vez que desees introducir un nuevo cambio, sólo hazlo en tu archivo md. Y deja que Pandoc o algún otro software se encargue del resto.

Más recursos

Hay mucho más que puedes hacer con markdown; por ejemplo, tablas y recursos gráficos estadísticos. Para tablas, te recomiendo leer el manual de Pandoc. Para representación gráfica de datos, busca gnuplot, visidata y R-markdown.

No obstante, puedes dejar eso, por ahora, para cuando la curiosidad empuje a tu conocimiento, ése que llevas contigo a todas partes y que te será útil en cualquier computadora de cualquier potencia que tengas a la mano, de modo semejante a la materia de que esté hecha tu escritura y lo que tengas para decir al mundo.

Dejaré aquí dos enlaces más a otros textos que quizá te resulten de interés, si deseas considerar algunas razones para escribir en texto plano con markdown:

• Escritura sostenible en texto plano usando Pandoc y Markdown.

• A favor del texto plano.

• La letra, la tecla, la escritura. Apuntes sobre la escritura electrónica.

No tengo la menor duda de que entre más practiques la escritura en markdown, menos trabajarás cada vez que debas publicar o entregar un documento escrito (una tarea escolar, un artículo, una tesis, un libro…). Verás qué pronto tus dedos escribirán de modo semejante a como los atletas mueven su cuerpo, a fuerza de entrenar reflejos. Eso, espero, te dejará un montón de tiempo libre para aprender cosas nuevas, leer libros, conversar con tu gente querida o cualquier otra actividad que disfrutes. Después de todo, de eso más o menos va la vida, el aprendizaje, la escritura: de tener tiempo para ser un poco más feliz.

—Publicado bajo licencia cc by-sa.

Volver al índice principal