Sintaxis Markdown

Ahora que hemos visto como crear un proyecto, profundicemos en la sintaxis markdown.

Markdown es un formato sencillo y fácil de escribir, ideado en 2004 por John Gruber. Se trata de un proyecto que ha evolucionado muy poco desde su creación, lo que ha dado lugar a que surjan diferentes versiones mejoradas. McDocs utiliza Python Markdown, bastante parecida a la versión original, con algunos añadidos.

Es posible que el editor que utilicemos, que en mi caso es Visual Studio Code, cuente con un panel de previsualización que utiliza su propia versión de markdown. Esto hace que el aspecto final de las páginas web generadas por MkDocs no coincida con la previsualización ofrecida por el editor.

Podemos ver las especificaciones originales en la página web de John Gruber, daringfirewall. En esta misma página encontraremos un pequeño editor on line para experimetar con el formato markdown. Para ello, introducir un texto cualquiera en el panel Markdown source:

Hola

Al pulsar en el botón [Convert] se mostrará un panel HTML:

<p>Hola</p>

Y debajo otro panel Preview con el aspecto final del texto.