A la hora de crear documentación, sobre todo en sitios como Github o Bitbucket, donde uno se acostumbra a leer muchos README, un gran porcentaje está escrito en Markdown, haciendo que Markdown se convierta en un lenguaje del día a día, por lo tanto es bueno que muchos conozcamos que es realmente este lenguaje y algunos ejemplos de su implementación.
Segun Wikipedia:
Este lenguaje es otro legado de Aaron Swartz, y está muy extendido junto a otros lenguajes como RSS, ReStructuredText, BBCode (Usado en Cristalab), YAML, JSON y más. Pero ¿Qué hace tan especial a Markdown?
Bajo mi punto de vista, y según mi experiencia a lo largo de estos años, Markdown ha tomado fuerza y se ha convertido en un lenguaje muy extendido en las comunidades por su sencillez y fácil implementación en distintos sistemas. Markdown se ha convertido en un lenguaje muy práctico, permitiendo el uso de texto plano pero sin sacrificar el formato de texto.
Con Markdown se pueden escribir documentos y luego exportarlos a HTML sin saber HTML, además la legibilidad es mayor porque no se necesitan etiquetas de marcado al estilo XML.
Un ejemplo de un documento en Markdown
Código :
# Esto es un titulo ## Esto es un subtitulo * Esto es una lista * Esto es otro elemento de la lista * [Esto es un link en una lista](http://www.cristalab.com) * ![Imagen](http://www.foo.com/bar.jpg)
Esto en HTML:
Código :
<h1>Esto es un titulo</h1> <h2>Esto es un subtitulo</h2> <ul> <li>Esto es una lista</li> <li>Esto es otro elemento de la lista</li> <li><a href="http://www.cristalab.com">Esto es un link en una lista</a></li> <li><img src="http://www.foo.com/bar.jpg" alt="Imagen" /></li> </ul>
Párrafos
Código :
Texto en cursiva: *texto en cursiva* o _texto en negrita_ Texto en negrita: **texto en negrita** o __texto en negrita__ Texto tachado: ~~texto tachado~~ Combinando texto en negrita con letras cursivas y tachado: **Este texto es en negrita, hay _cursiva_ y ~~tachado~~**
Listas numéricas
Código :
1. Primer elemento 2. Segundo elemento 1. Sublista 2. Sublista 3. Tercer elemento * Sublista desordenada
Tablas
Código :
Markdown | Foo | Bar --- | --- | --- *Foo* | `Bar` | **Foo** 1 | 2 | 3
Y el resultado:
Como pueden observar uno se ahorra muchos caracteres. Markdown va mucho mas allá de eso y permite hasta resaltado de sintaxis de una gran cantidad de lenguajes de programación de una manera sencilla.
Ejemplo:
Código :
```python def main(): print "hola mundo" ```
o en otros casos dejando un margen de 4 espacios:
Código :
def main(): print "hola mundo"
- Pueden ver ejemplos en: Markdown-Here-Cheatsheet
- Github tiene su propia versión de Markdown, llamada Flavored Markdown
- Si desean jugar un rato, o para aprender tiene un editor online
- Wordpress tiene un plugin para tener un editor propio de Markdown
Yohan Graterol (@yograterol)
¿Sabes SQL? ¿No-SQL? Aprende MySQL, PostgreSQL, MongoDB, Redis y más con el Curso Profesional de Bases de Datos que empieza el martes, en vivo.
Por javiertapia el 07 de Enero de 2014
Por yograterol el 07 de Enero de 2014
javiertapia-blog :
Gracias Javier por tu comentario y mencionar las diferencias, en efecto, el resaltado de sintaxis se encuentra en variaciones de Markdown, el Markdown "original" transforma en el caso de los 4 espacios a la etiqueta "<code>" sin especificar un lenguaje. Pero gracias a la generosidad de muchas personas, tenemos variaciones de Markdown que nos formatea el código. como el de GitHub que es Flavored Markdown, al final del artículo está el link.
Saludos!
Por ebuzz el 19 de Enero de 2014