Por Miguel Paz
(Una guía rápida)
Markdown es “una herramienta de conversión de texto a HTML para escritores web”, creada por John Gruber con el objetivo de ayudarte a concentrar en la escritura en vez de en el formateo del documento y lo qué sucede con dicho formato cuando exportas el documento a otro formato (un revoltijo).
Esto significa que el documento de texto que escribes utilizando la sintaxis de Markdown se convierte a HTML (y puede ser exportado a otros formatos como .PDF y .Doc sin inconvenientes).
Markdown usa caracteres de puntuación comunes. Por ejemplo: si rodeas con asteriscos una *palabra en itálica*
esta se verá como palabra en itálica y en HTML como <i>palabra en itálica</i>
. ¿Dos asteriscos? **Palabra en negritas**
se transforma en palabra en negritas y en <b>palabra en negrita</b>
. Markdown tiene estilos de sintaxis para títulos, listas, citas o block quotes, enlaces y más (ver abajo). Muy relevante: “es usado en todas las formas de escritura en Github”.
Un detalle: puedes escribir contenido y transformarlo en HTML pero Markdown no añadirá las etiquetas de estructura de un documento HTML (Ej: <!document type>
, <body>
, etc.). Tu tendrás que hacerlo en el HTML.
Muchas salas de redacción y periodistas usan Markdown para escribir sus contenidos, especialmente si pasan por un proceso de edición y de producción digital colectiva que incluye a otros reporteros, diseñadores y programadores.
En Poynter escribieron no hace mucho de un caso típico de los nuevos tipos de flujo de trabajo editorial que involucra el uso de Markdown: “Los periodistas de investigación en el Marshall Project escriben directamente en Google Docs y comparten sus textos con un editor cuando han terminado. Entonces, un script de código que Vong [Ivar Vong, director de tecnología] escribió, convierte el texto a lenguaje Markdown que el diseñador gráfico usará cuando diseñe la historia para el sitio web de el Marshall” project.
Es una de las herramientas que decenas de operaciones periodisticas digitales ya han adoptado para “reducir las barreras entre programadores y no programadores” que trabajan juntos, descubrió el Tow Center for Digital Journalism.
Reporteros en NPR y ProPublica usan Markdown como parte de su flujo de trabajo para producir y manejar los textos de sus artículos y reportajes. Vox Media adquirió Editorially (una startup que redefinió la experiencia de escritura, control de versiones y colaboración editorial, mediante el uso de Markdown entre otros de sus grands caracterñisticas), para potenciar su, de por sí, innovadora tecnología de publicación. Plataformas y startups como Stack Overflow, Carto, Codeacademy, para nombrar algunas, han adoptado Markdown como su herramienta de formateo de contenido.
¿Por qué tanta vaina con Markdown? Bueno, pues porque es tan fácil de aprender su sintaxis que es a prueba de periodistas. Permite escribir de modo muy rápido sin preocuparse del interlineado o los espacios entre párrafos o los estilos tipográficos y tamaños de letra o lo que sea que en un documento Word normalmente haces haciendo click en las opciones del menú del programa, para que tu texto se vea lindo. Acá no. Dos cucharadas y a la papa, como dicen los antiguos en Chile.
Como los documentos de Markdown son documentos de texto simple, puedes usar cualquier editor de texto para crear, editar y guardar un documento. Es decir, puedes escribir estilo Markdown en Sublime Text, Atom, Vim, Visual Studio, Brackets, Notepad++ o cualquier otro editor de texto que prefieras. Sólo recuerda una regla primordial: debes guardar el documento con la extensión de archivo punto md o punto markdown. Así: nombredearchivo.md
o bien nombredearchivo.markdown
.
A continuación, la sintaxis básica para formatear textos en Markdown (via la guía de Github “Mastering Markdown”.
Bloque de código con sintaxis resaltada
# Título 1 o h1
## Título 2 o h2
### Título 3 o h3
#### Título 4 o h4
##### Título 5 o h5
###### Título 6 o h6
- Lista
- Con viñetas
1. Lista
2. Numerada
**Negritas**
*Itálica*
***Itálica & negritas juntas***
`Código`
Línea horizontal
*******
> Cita o bloque de cita
[Enlace](url)
Para añadir una imagen: ![Imagen](fuente de la imagen, una url)
Para más ejemplos y opciones avanzadas de sintaxis revisa:
Mientras un editor de texto ofrece un modo sencillo y rápido de crear un documento .md
, el beneficio real de utilizar Markdown es evidente cuando tienes que convertir el archivo a otro formato para publicación, como HTML (web), .PDF (libro) o un documento Word (para edición tradicional).
Si eres periodista, como ya leíste, quizás tengas que escribir un artículo en Markdown, convertirlo a HTML y añadirle cascadas de estilos (CSS) y scripts de Javascript para la puesta en página web. O bien, tendrás que enviar el archivo .md
a un editor, a un colega del área de gráficos interactivos o a un desarrollador web. Lo más probable es que todo lo anterior lo estarás haciendo dentro de un repositorio de Github al cual tu equipo y tú tienen acceso.
Ya que ese es tu caso, te irá mucho mejor si escoges y utilizas uno de los muchos editores de Markdown existentes. Puedes buscar “mejores editores de Markdown” o “best Markdown editors” para descubrir el que satisfaga tus necesidades.
Preparé una lista corta de editores favoritos para escritorio y para trabajo en línea. Todos permiten guardar y sincronizar tu trabajo con servicios en la nube, así como prever los cambios que realizas en tiempo real para ahorrar tiempo y energía.
Si sigues buscando verás que hay muchas, muchsimas más opciones. Prueba los que te parezcan hasta encontrar tu editor ideal.
¿Mencioné que puedes añadir emojis en algunas versiones extendidas de Markdown, como la que usa Github?
:metal:
:clap:
:rocket:
:tada:
Para finalizar, realiza este ejercicio de escritura con Markdown, fork y pull request.
La guía Markdown para periodistas es parte de los materiales del curso Craft 2 del Programa Bilingüe de la Maestría de Periodismo de CUNY