Introducción a Markdown
Todo lo que necesita saber para comenzar su viaje con Markdown.
¿Qué es Markdown?
Markdown es un lenguaje de marcado utilizado para formatear documentos de todo tipo, creado por John Gruber y Aaron Swartz en 2004, hoy en día es uno de los lenguajes más populares entre los programadores.
Según Wikipedia:
NOTA: Un lenguaje de marcado es un lenguaje que usa tags o símbolos para aplicar estilización al contenido. Los lenguajes de marcado más populares en el mundo son HTML, XML y Markdown.
En la imagen de abajo puede ver un archivo formateado con Markdown en el editor de texto Sublime Text.
Un archivo Markdown o MD está compuesto de texto sin formato, es fácil de entender y no tiene todo ese marcado HTML contaminando el contenido.
NOTA: MD es la abreviatura de Markdown.
Con Markdown puede agregar formato a su documento usando el marcado de símbolos.
Es importante notar que el formato Markdown es diferente del formato usado por algunos editores WYSIWYG .
NOTA: WYSIWYG es la abreviatura de What You See Is What You Get . Básicamente, el formateo del contenido ocurre en tiempo real, es decir, es visible de inmediato. Para obtener más información, puede consultar este artículo de Wikipedia.
Por ejemplo, en Microsoft Word, que es un editor de WYSIWYG, el formateo de texto ocurre seleccionando un determinado contenido y presionando un botón específico, una combinación de teclas o alguna opción de menú.
En Markdown, el formato se aplica mediante símbolos como el signo de almohadilla #, el asterisco * y el guión bajo _.
Esta simbología la utiliza el procesador Markdown para saber qué palabras / frases deben formatearse al convertir su archivo a HTML.
Por ejemplo, **Quiero que este texto esté en negrita** y _este texto en cursiva_
¿Muy confuso? Simpliquémoslo un poco.
Cuando rodeas el contenido con dos asteriscos ** lo enfatizas en negrita, en el segundo ejemplo usamos un guión bajo _ para aplicar la cursiva.
Cómo editar un archivo Markdown
Un archivo Markdown no es más que texto, por lo que cualquier editor de texto simple es suficiente para la tarea.
Sin embargo, es interesante tener en cuenta:
- Un editor que te permite convertir nuestro documento Markdown a otro formato.
- Un editor que puede resaltar la sintaxis de Markdown.
- Un editor que muestra la conversión a HTML en tiempo real
La buena noticia es que:
- Hay varias aplicaciones Markdown para varios sistemas operativos, incluyendo, para Windows, para Linux, para Android e incluso, para iOS.
- Cuando se trata de Web, las cosas mejoran aún más, varios sitios ofrecen aplicaciones gratuitas de Markdown para que edites tus documentos online, y lo mejor, muchos tienen un convertidor en tiempo real, es decir, mientras escribes la aplicación, ya estarás convirtiendo a HTML.
NOTA: Vale la pena recordar que el formato Markdown es extremadamente simple, por lo tanto, un documento formateado con este idioma, aún es legible.
Markdown frente a WYSIWYG
Si un editor WYSIWYG (que ofrece formateo en tiempo real) es extremadamente conveniente, ¿por qué debería usar Markdown?
Si usando un editor WYSIWYG puedo presionar un botón y tener el formato que quiero, ¿por qué voy a escribir un documento con el marcado Markdown?
Veamos algunas razones para usar Markdown:
- Markdown se puede utilizar para crear casi cualquier tipo de documento, ya sean sitios web, libros, presentaciones, e-mails, documentación técnica y mucho más.
- La portabilidad de Markdown es excepcional. Debido a que es un documento de texto sin formato, se puede editar en cualquier aplicación de texto. Si lo contrastamos con Microsoft Word, el formato
docxes propietario y necesita un programa específico para abrirse, lo que no es el caso demd. - Libre de elegir qué programa usar para editar sus documentos, un archivo "
- No importa qué sistema operativo use, Windows, Mac o Android, Markdown es compatible.
- Tenga su documento accesible incluso en caso de catástrofe. ¿Tu editor de texto favorito ya no funciona? ¿Ha terminado el soporte? ¿Se pagó el programa? No hay problema, simplemente elija cualquier otro editor de texto y continúe editando y accediendo a su documento, lo cual es extremadamente importante para archivos como documentación técnica, libros y TCC.
- La gigantesca comunidad Markdown lo ha hecho accesible en varios sitios web como el idioma estándar para dar formato a las publicaciones. GitHub y Reddit son ejemplos de sitios famosos que utilizan Markdown.
- Un gran número de personas ya usa Markdown, por lo que sus documentos formateados serán entendidos por más y más personas.
Practicando
¡La mejor forma de aprender es practicando!
Es interesante que tenga disponible un editor Markdown mientras aprende la sintaxis del idioma.
La forma más rápida de empezar a practicar Markdown es utilizar los editores online. Con las aplicaciones Web no necesita descargar nada, simplemente acceda al sitio web y comience a editar su archivo md.
StackEdit, Dillinger y Editor.md (Markeditor) son buenas opciones para empezar.
NOTA: Abra uno de los editores online en otra pestaña de su navegador para entrenar la sintaxis de Markdown en tiempo real.
StackEdit
El StackEdit es una de las aplicaciones más completas. Además del editor, también proporciona un convertidor en tiempo real que muestra HTML en el panel derecho.
Vea más información sobre StackEdit en la sección de herramientas.
Dillinger
El Dillinger tiene una interfaz muy simple, pero ofrece varias opciones para editar su documento Markdown. Además de la conversión en tiempo real, también puede exportar el archivo a formatos HTML y PDF
Para obtener más información sobre Dillinger haga clic aquí.
Editor.md (Markeditor)
El Editor.md es una herramienta de código abierto, tiene un conversor de MD a HTML en tiempo real y botones que te permiten crear elementos Markdown con un solo clic.
¿Y después?
Después de adquirir más experiencia, puede descargar una aplicación para su sistema operativo y comenzar a editar documentos localmente.
En la sección de herramientas encontrará una extensa lista de aplicaciones con instrucciones sobre cómo utilizarlas e información sobre la compatibilidad con los elementos Markdown.
Bueno, ahora que tiene un editor disponible para practicar Markdown, entendamos cómo funciona la conversión de un formato a otro.
Cómo convertir un archivo Markdown
Entendamos el procedimiento utilizado por las aplicaciones Markdown para convertir su archivo md a otro formato, generalmente HTML o PDF.
La simplicidad de Markdown
¿Cómo se identifica un archivo Markdown? Por extensión, ¿correcto? Normalmente md o markdown.
Un archivo Markdown no tiene formato, no es un archivo encriptado, y mucho menos compilado.
NOTA: Esta simplicidad permite a los programas analizar su texto en busca de símbolos que identifiquen los elementos Markdown.
Varias aplicaciones Markdown, además del editor, también tienen un conversor integrado. El convertidor es responsable de traducir la sintaxis de Markdown a otra formateada.
Cómo se realiza la conversión
El convertidor Markdown usa un Parser para escanear su contenido en busca de marcas que sean compatibles con Markdown; Cuando encuentra un marcado compatible, Parser busca una coincidencia en el formato de salida, por ejemplo, un tag HTML que produce el mismo formato.
A continuación, puede ver una tabla de ejemplo de correspondencia entre un marcador Markdown y un tag HTML.
Tenga en cuenta que el formato HTML es uno de los más utilizados cuando se trata de convertir Markdown. Su archivo convertido a HTML se puede ver en cualquier navegador Web como Google Chrome, Mozilla Firefox y Microsoft Edge.
En la imagen a continuación, puede ver una versión simplificada del proceso de conversión.
NOTA: Es importante tener en cuenta que, en una aplicación más robusta, los componentes se pueden separar, incluso, pueden ser independientes entre sí. El editor, el convertidor, el analizador, etc. La imagen de arriba es solo una representación simple de cómo ocurre el procedimiento.
Resumamos la conversión en cuatro pasos.
- Primero tenemos que crear un archivo Markdown, para eso, agregamos la extensión
mdomarkdownal guardar el documento. Durante la edición, cualquier editor de texto servirá. - Luego, cargamos el archivo en alguna aplicación Markdown.
- Ha llegado el momento de convertir a otro formato, en nuestro caso, HTML. En este paso, una aplicación dedicada a Markdown es fundamental.
- Ver el resultado de la conversión. Si es HTML, simplemente abra el archivo en un navegador.
Algunos puntos deben destacarse
- Este procedimiento puede variar dependiendo de dónde esté editando su archivo Markdown.
- Cuando hablamos de edición simple, es decir, usando cualquier editor genérico, estos pasos son más evidentes.
- En el caso de editores en línea como Dillinger, StackEdit y Editor.md, hay una combinación de los pasos 2, 3 y 4 directamente en la interfaz gráfica de estas aplicaciones.
Usando Markdown
Crear contenido para Web es la forma más popular de usar Markdown. No solo en la generación de páginas HTML, sino también en la creación y edición de posts de todo tipo, desde la creación de simples comentarios hasta la elaboración de documentación técnica.
También puede formatear listas de tareas, mensajes e-mails, listas de compras y más.
A continuación, puede ver algunos ejemplos de documentos que se pueden crear usando Markdown.
Sitios web
John Gruber y Aaron Swartz desarrollaron Markdown con Internet en mente, por lo que la creación de contenido para Web se convirtió en una de las mayores atracciones del idioma.
Muchas aplicaciones, compatibles con Markdown, ya convierten automáticamente su contenido en HTML.
Puede crear sitios web completos utilizando el formato Markdown como base. Si eso es lo que quiere hacer, herramientas como Jekyll y MkDocs pueden satisfacer sus necesidades.
Jekyll y MkDocs son herramientas que generan sitios web estáticos a partir de documentos Markdown. Sepa que al crear sitios web, es interesante que tenga un mínimo de familiaridad con HTML, CSS e incluso con versiones de archivos usando Git.
Las páginas GitHub proporcionan alojamiento gratuito para su sitio web estático.
Si necesita algo más robusto como un administrador de contenido, el famoso CMS, eche un vistazo a Ghost.
Ghost es una plataforma gratuita y de código abierto para bloggers. La herramienta también tiene un editor Markdown incorporado.
¿Utiliza WordPress? Los sitios alojados en WordPress.com ya tienen soporte para Markdown, sin embargo, puede usar plugin Jetpack para sitios que están en otros servidores de alojamiento.
Dar formato al texto
La simplicidad de Markdown prescinde de todas las opciones llamativas de un editor WYSIWYG, como Microsoft Word, pero aún ofrece suficiente formato para editar sus documentos.
El idioma admite negrita, cursiva y tachado, además de, por supuesto, listas, títulos, blockquotes y más.
Otra ventaja de formatear documentos usando Markdown es la posibilidad de convertirlos básicamente a cualquier otro formato de archivo de texto.
A continuación se muestra una lista de aplicaciones para crear / editar documentos Markdown:
- Windows: ghostwriter o Markdown Monster
- Linux: ReText o ghostwriter
- Mac: MacDown, iA Writer o Marked
- Web: Dillinger o StackEdit
- iOS / Android: iA Writer
Notas
Markdown es el lenguaje perfecto para tomar notas.
A continuación se muestra una lista de aplicaciones compatibles con Markdown.
- Notable: destaca por su compatibilidad con varias plataformas.
- Bear: Entramos en territorio de Apple, Bear es compatible con Mac e iOS, no usa Markdown por defecto, pero puedes activarlo. Bear es muy similar a Evernote.
- Simplenote: es gratis, es simple y almacena notas. Disponible en todas las plataformas.
- Boostnote: más enfocado a programadores, además de tener código fuente abierto.
¿Y Evernote? OneNote? Alguien...?
Así es...
Cuando se trata de aplicaciones para tomar notas, Evernote y OneNote son, sin duda, las más populares. Desafortunadamente, los dos programas, por defecto, no son compatibles con Markdown.
En el caso de Evernote, puede usar Markdown Here o Marxico.
NOTA: Markdown Here es una extensión para su navegador que le permite crear emails usando la sintaxis de Markdown. Puede utilizar esta misma extensión en el sitio web Evernote.
Libros
¿Qué quiere decir escribir libros usando Markdown?
Así es, servicios como Leanpub usan archivos Markdown como base, la conversión se realiza para EPUB, MOBI y PDF.
¿No te gustan mucho los libros electrónicos?
Con el archivo de su libro electrónico generado puede subirlo a otros servicios como Kindle Direct Publishing y producir copias físicas.
Presentaciones de slides
Sí, has leído bien, es posible crear presentaciones de slides usando Markdown.
Remark, Cleaver y Landslide son herramientas que generan presentaciones slides directamente en su navegador, todas usan archivos md como base.
¿Prefieres usar aplicaciones? En macOS puede consultar el Marked o Deckset. En Windows podemos convertir Markdown a slides usando Pandoc.
Puede parecer una pérdida de tiempo generar presentaciones usando el marcado Markdown, sin embargo, con un poco de práctica descubrirás que es mucho más fácil y rápido que usar una herramienta como PowerPoint o Keynote.
E-mails
La mayoría de los proveedores de e-mail proporcionan un editor WYSIWYG integrado con la interfaz, pero seamos sinceros, muchos dejan algo que desear, por un lado hay mucha complejidad, por otro lado, carecen de opciones de formato.
¿Y ahora?
Markdown Here es la solución para estos casos. Una extensión para su navegador que le permite escribir su e-mails usando el formato Markdown.
¿Es gratis?
Sí, Markdown Here es gratuito, de código abierto y convierte Markdown a HTML instantáneamente.
Documentación técnica
Markdown y la documentación técnica van de la mano. Innumerables empresas utilizan archivos "mdpara almacenar su documentación.
GitHub migró sus documentos a Markdown con el apoyo de la herramienta Jekyll. Además, uno de los archivos más famosos del mundo, el README.md de GitHub está compuesto por Markdown.
NOTA: GitHub usa una pequeña variante de Markdown llamada GitHub-flavored Markdown.
Para la creación de documentación técnica, las siguientes herramientas pueden ayudarlo:
- Jekyll: Genera documentación a partir de archivos Markdown, es la elección de las páginas GitHub.
- MkDocs: Sencillo, rápido y fácil de usar. La base de la documentación son los archivos .md, la configuración utiliza archivos YAML.
- Docusaurus: Generador de sitios web estáticos, una de las mejores herramientas para crear documentos. Docusaurus fue desarrollado por Facebook, admite control de versiones, búsqueda de documentos e incluso traducciones.
- Read The Docs: Genera sitios de documentación basados en archivos Markdown.
- VuePress: Por el nombre entiendes que tiene alguna relación con Vue, tal como es, VuePress es un generador de sitios web estáticos destinados a redactar documentación técnica.
Sabores de Markdown
Imagínese todos los diferentes dialectos que existen en un idioma, jerga, pronunciamientos, acentos. Incluso para los hablantes nativos, a veces es difícil entender algunas cosas.
Tal como está, al igual que con los lenguajes, las implementaciones de Markdown en diferentes programas también pueden variar, incluso si la diferencia es sutil, aún puede causar confusión.
Las variaciones de Markdown se denominan Flavors, por ejemplo, GitHub usa una versión un poco más robusta de Markdown llamada GitHub-flavored Markdown o GFM.
Algunas aplicaciones usan solo sintaxis básica, otras usan una combinación de sintaxis básica y sintaxis extendida, y finalmente, hay aquellas que implementan esporádicamente elementos de ambas.
¿Que hacer?
La mejor forma de entender una aplicación es consultar su documentación. También puede utilizar la vieja táctica de prueba y error. Consulte también nuestra lista de herramientas donde enumeramos qué elementos de Markdown son compatibles con cada aplicación.
Al final del día, la mejor opción es utilizar un programa que ofrezca la mayor compatibilidad posible, como Dillinger o StackEdit.
Algunos ejemplos de sabores de Markdown son, GFM (GitHub-flavored Markdown); MultiMarkdown; Markdown Extra, Kramdown.
Conclusión
En este artículo aprendiste los aspectos básicos de Markdown, lo que puedes hacer con él y sus diferentes implementaciones.
El siguiente paso es aprender la sintaxis básica del lenguaje o, si ya está seguro, consulte la sección herramientas para comenzar a usar Markdown.