Sintaxis de Markdown

¿Qué es markdown?

Markdown es un lenguaje de marcado ligero. Markdown permite escribir escribir en texto plano haciendo que sea de forma fácil de leer y fåcil de escribir, para luego convertirlo a XHTML o HTML.

Markdown fue implementado originalmente en perl y con el tiempo ha sido portado a multitud de lenguajes como Java, Python, PHP, etc.

¿Por qué elegir Markdown?

Al contrario que otros lenguajes de marcado, Markdown no usa palabras para el marcado por lo que si usamos algún sistema de búsqueda no habrá problema en que reconozca el marcado como la cadena que estamos buscando.

Sintaxis de Markdown

Aunque Markdown tiene más sintaxis que las que aquí se exponen he decidido restringir el artículo al Markdwon que se usa en debugmodeon.

Saltos de línea

Para forzar a Markdown a incluir un <br/> al final de una línea hay que incluir dos o más espacios al final de la línea, antes del salto de línea. Nota No usar en los encabezados.

Encabezados

Los encabezados se marcan con el símbolo almohadilla (#) de 1 a 6, correspondíendose con el número de elementos h de html que existen, así por ejemplo

 # Es un bloque h1
 ## Es un bloque h2
 ...
 ###### Es un bloque h6

Opcionalmente se pueden 'cerrar' los encabezados, aunque es simplemente para cumplir una cuestión estética, ya que no afecta al parseado del Markdown, un encabezado es una línea.

 # Es un bloque h1 #
 ## Es un bloque h2 ##
 ...
 ###### Es un bloque h6 ######

Cursivas

Para marcar una palabra o varias como cursiva tenemos que colocar un asterisco (*) antes y después de la palabra o bloque de palabras a marcar. Markdown también admite marcar las cursivas con guiones bajos (_).

 *Es una cursiva*
 _Es una cursiva_

Negritas

Para marcar una palabra o varias como negrita tenemos que colocar dos asteriscos (**) antes y después de la palabra o bloque de palabras a marcar. Markdown también admite marcar las negritas con guiones bajos (__).

 **Es una negrita**
 __Es una negrita__

Enlaces

Para marcar una palabra o varias como enlace tenemos que incluir la palabra o bloque de palabras entre corchetes y seguido de la URL entre paréntesis

 [Es un enlace](http://www.debugmodeon.com/item/80821/sistaxis-de-markdown)

Imágenes

Para incluir una imagen

 ![Texto en el alt](http://www.debugmodeon.com/images/user/avatar/debugmodeon/2)

Listas no numeradas

Para marcar una lista como lista no numerada debemos incluir un asterisco(*) por cada línea. Además, como es evidente, cada punto de la lista dbee ir en una línea nueva.

 * Primer punto
 * Segundo punto
 * Tercer punto

También se pueden usar los carácteres de suma (+) y guión (-). Por lo cual esto es equivalente al marcado anterior

 + Primer punto
 + Segundo punto
 + Tercer punto

 - Primer punto
 - Segundo punto
 - Tercer punto

Listas numeradas

Si lo que queremos es marcar una lista como lista numerada simplemente debemos añadir el número seguido de un espácio en cada elemento de la lista. Esta opción no genera ningún HTML, sino que deja el texto tal cual lo ha escrito el usuario.

1.  Primer punto
2.  Segundo punto
3.  Tercer punto

Citar

En foros y artículos es muy común el citar alguna fuente externa o algún usuario anterior, para macar como cita un texto este debe empezar con un símbolo de "mayor que" (>). El texto a citar debe ir en una línea nueva, Markdown tomará como cita todas las palabras hasta que se produzca un salto de línea.

 >Esto es una cita
 >Esto otra
 Esto ya no

Bloques de código

Para marcar un bloque de texto como código hay que incluir 4 espacios al inicio de cada línea.

Código en línea

No siempre es útil crear un bloque de código, en muchas ocasiones queremos marcar ciertas palabras como código, para ello usaremos la notación de código en línea.

`es código en línea`

Links automáticos

Markdown soporta el marcado de una URL como links de la siguiente forma http://www.debugmodeon.com, para marcar un link de esta forma basta con incluir la URL de la siguiente forma

 <http://www.debugmodeon.com>

La misma funcionalidad sirve para los emails, <contacto@debugmodeon.com>

 <contacto@debugmodeon.com>

Escapar caracteres

Para escapar los caracteres de marcado debemos utilizar la contrabarra \

Markdown en el editor de debugmodeon

El editor de debugmodeon contiene una serie de botones que ayudan a marcar el texto que queramos incluir sin necesidad de saber todos los códigos.

1. Para marcar cursivas. Para utilizarlo basta con seleccionar la palabra o palabras que queremos marcar como cursiva y hacer clic el botón.
2. Para marcar negritas. El funcionamiento es igual que el del botón anterior.
3. Para introducir un link. Tenemos que seleccionar la palabra o palabras que queremos que sean el link, hacer clic en el botón y escribir la URL en el diálogo que aparece.
4. Para incluir imágenes. Haciendo clic en este botón y escribir la URL a la imagen en el diálogo que aparece.
5. Para marcar encabezados. Seleccionando la palabra o palabras y haciendo clic introducirá el marcado para generar un H4, añadiendo o quitando a mano obtendremos los otros.
6. Para generar una lista no ordenada. Seleccionamos las diferentes líneas del listado y hacemos clic en el botón.
7. Para generar una lista ordenada. Lo mismo que el elemento anterior.
8. Para citar. Lo mismo que el punto anterior.
9. Para marcar un bloque de texto como código. Hay que seleccionarlo y hacer clic en este botón, incluirá 4 espácios delante de cada línea.
10. Para introducir contenido media. Aunque esto no forma parte de la sintaxis de Markdown, hemos creído importante ofrecer la posibilidad de incrustar contenido media en los artículos y foros. Para incrustar un vídeo hay que pegar la URL en el editor, seleccionarla y hacer clic en el botón. Por el momento soportamos YouTube, Vimeo, YahooVideo.

Otros lenguajes de marcado

• BBCode
• Textile

Links de interés

• Página de Markdown
• Sintaxis de Markdown
• Utilizar Markdown en Google App Engine. Publicado en debugmodeon.
• Editor de Markdown basado en prototype El editor que usamos en debugmodeon.
• Markdown para PHP
• Markdown para Java