Una introducción a Markdown

Reducción

Markdown es una herramienta de conversión de texto a HTML. Hoy en día se ha convertido en el sinónimo de facto de una clase de lenguajes de descripción de marcado ligeros. Utiliza una sintaxis de formato de texto plano. La idea detrás de Markdown era hacer que escribir páginas web y especialmente entradas de blog fuera tan fácil como escribir un correo electrónico. En el momento de noviembre de 2017, la meta está alcanzada y Markdown así como sus derivaciones Asciidoc, Asciidoctor y Asciidoctor-pdf están ampliamente en uso.

Markdown se centra solo en texto sin formato y se abstiene de todas las demás complejidades que se encuentran en HTML. Es fácil de aprender, ya que se mantiene simple, por lo tanto, también más rápido ya que se utilizan caracteres mínimos, lo que también conduce a menos posibilidades de un error al final. Consulte la figura 1 para ver un documento básico que se muestra en el editor de Markdown Stackedit. En el lado izquierdo verá el código fuente y en el lado derecho la salida HTML correspondiente. Puede notar que los títulos simplemente están marcados con un número de # según el nivel de jerarquía del título.

Conversión de texto

El texto sin formato es convertible a XHTML (HTML) y muchos otros formatos usando las herramientas de línea de comando como Markdown o Pandoc. Básicamente, ambas herramientas crean solo fragmentos HTML y escriben la salida en stdout. Pandoc ofrece el interruptor "-o nombre de archivo" para escribir la salida HTML en el archivo dado. Como se ve a continuación, el archivo de salida se denomina básico.html y contiene el fragmento HTML: dos títulos y un párrafo.

$ pandoc -o básico.html básico.md $ cat básico.html 
Cómo crear un paquete Debian
 
Prefacio
 Ser responsable de una máquina significa cuidar tanto el hardware como los componentes del software. Como se ve en la vida cotidiana como administrador de sistemas, es mucho mejor instalar el software como un paquete de software en lugar de un montón de archivos de origen. Esto reduce los costos para mantener adecuadamente el sistema. PS 

Para crear documentos HTML independientes con un encabezado HTML completo, Pandoc acepta el cambio "-s" de la siguiente manera:

$ pandoc -o básico.html -s básico.md $ cat básico.html           
Cómo crear un paquete Debian
 
Prefacio
 Ser responsable de una máquina significa cuidar tanto el hardware como los componentes del software. Como se ve en la vida cotidiana como administrador de sistemas, es mucho mejor instalar el software como un paquete de software en lugar de un montón de archivos de origen. Esto reduce los costos para mantener adecuadamente el sistema.   

La ventaja de mantener el contenido separado de su pantalla visual es que no estropeará el aspecto de su sitio. Versión 1.0.1, que fue desarrollado por John Gruber y Aaron Swartz, fue lanzado en diciembre de 2004 y está disponible como software gratuito (ver enlaces al final de este artículo).

Elementos de texto

Titulares

Según el nivel HTML correspondiente, los titulares se escriben con un número de # de la siguiente manera:

# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6 

Para H1 y H2 se aceptan dos formas alternativas de escritura:

H1 == H2 -- 

Tenga en cuenta que el número de signos o guiones iguales debe coincidir con el número de caracteres del título.

Destacando el texto

Para enfatizar el texto, se admiten estos elementos:

• cursiva: asteriscos simples o guiones bajos simples
  --
  * importante * y _también importante_
  --
• texto en negrita: asteriscos dobles o guiones bajos dobles
  --
  ** importante ** y __también importante__
  --
• texto tachado: tildes dobles
  --
  ~~ texto ~~
  --

Liza

Markdown admite listas ordenadas y desordenadas. Las listas ordenadas comienzan con un asterisco, un signo más o menos. Las listas ordenadas solo comienzan con un dígito. Para crear sublistas, aplique una sangría al elemento de la lista con dos espacios (Markdown, StackEdit) o ​​cuatro espacios (Pandoc) como se ve a continuación:

1. frutas * manzana * plátano 2. bebidas + agua + leche 

Imagenes

La forma más sencilla es utilizar el estilo en línea de la siguiente manera:

![El logotipo de Debian] (debian-logo.png "Logotipo de Debian") 

Esto muestra la imagen de referencia. Tan pronto como mueva el puntero del mouse sobre la imagen, verá el texto de descripción correspondiente.

Resaltado de código y sintaxis

Hay dos variantes: código en línea y bloques de código. El código en línea está enmarcado en tres comillas invertidas como "'print (" Hola, mundo!”)“ '. Los bloques de código también comienzan y terminan con tres comillas invertidas pero en líneas separadas de la siguiente manera:

"print (" Hola, mundo!”)"

Markdown no admite el resaltado de sintaxis, pero los dialectos como Markdown Here sí lo hacen.

Mesas

Markdown no admite tablas, pero extensiones como GFM y Markdown Here sí.

Blockquotes

Las citas en bloque comienzan con un signo ">". Resulta bastante útil citar texto.

> "Oh! es absurdo tener una regla estricta sobre lo que uno debe leer y lo que no debe. Más de la mitad de la cultura moderna> depende de lo que no se debe leer.">> La importancia de ser serio. (Oscar Wilde) 

Enlaces

Los enlaces hacen referencia a otros documentos o secciones del actual. El estilo de escritura es similar a las imágenes y consiste en la descripción del enlace entre corchetes y la URL entre corchetes regulares.

[Soy un enlace de estilo en línea] (https: // linuxhint.com) 

Además, puede agregar un texto alternativo:

[Soy un enlace de estilo en línea con texto adicional] (https: // linuxhint.com "LinuxHint") 

Los enlaces se pueden referenciar de la siguiente manera:

[LinuxHint] [1] ... algo de texto ... [1]: https: // linuxhint.com 

Esto le permite crear fácilmente listas de referencias al final de su documento, ya que es común en documentos científicos.

Conclusión

Markdown es bastante simple y una necesidad para todos los que realizan documentación y publican contenido con regularidad. Es un gran placer usarlo.

Referencias

• StackEdit, https: // apilado.io / editor
• Pandoc, http: // pandoc.org /
• Markdown, https: // bola de fuego atrevida.net / proyectos / markdown /
• Hoja de referencia de Markdown, https: // github.com / adam-p / markdown-here / wiki / Markdown-Cheatsheet