Escribe con Markdown (1)

Una de las herramientas que normalmente debe de saber un desarrollador para realizar documentación técnica o crear los Readme.md de los proyectos que vamos realizando es el lenguaje Markdown.

¿Qué es y porque utilizarlo?

Markdown nació como una herramienta para conversión de texto plano a HTML. Fue creada en 2004 por John Gruber y se distribuye bajo una licencia BSD de forma gratuita.

También suele ser considerada como un método de escritura ya que permite escribir y formatear al mismo tiempo mediante ciertos códigos escritos en el texto que estás escribiendo.

La ventaja de escribir en markdown es que es compatible con todas las plataformas por lo que puedes mantener todo tu contenido accesible desde cualquier dispositivo.

Además, al escribir en texto plano, el texto que escribes es lo único que tiene el archivo, mientras que otros procesadores de texto como Word, te añade mucho más código que en principio no es necesario ocupando más espacio en disco de lo que es necesario.

Otro de los objetivos de Markdown, es el poder publicar los documentos originales. No importa si el resultado final es HTML, un PDF o formato enriquecido ya que mediante conversores puedes obtener dichos formatos.

Sintaxis básica de Markdown

Al ser un lenguaje de texto plano la escritura básica es muy sencilla y solo hay que seguir unos pasos muy sencillos.

  • Para general un párrafo separa el texto mediante una línea en blanco (pulsando dos veces intro)
  • Para realizar un salto en línea y empezar una frase en otra línea dentro del mismo párrafo, tendrás que dejar dos espacios a final de línea antes de pulsar la tecla intro (pulsando dos veces la barra espaciadora y después intro)

Ejemplos

Separación de párrafos.

  // Para escribir párrafos solo hay que realizar una separación de salto     
  // de línea sin escritura

  Esto es un párrafo

  Esto es otro párrafo

  //Output
  Esto es un párrafo

  Esto es otro párrafo

Como en HTML, Markdown no soporta dobles líneas en blanco, así que aunque las generes, estas se convertirán solo en una

Separación líneas del mismo bloque

  // Para escribir líneas diferentes en el mismo párrafo     
  // para escribir código sin salto de línea
  // hay que dejar dos espacios al final y pulsar intro

  Línea del párrafo 1  //(dejas dos espacios y pulsas intro)(
  Segunda línea del párrafo 1  //(dejas dos espacios y pulsas intro)
  
  // Output
  Línea del parrafo 1
  Segunda línea del párrafo 1

Deja un comentario