Guía Markdown

¿Qué es Markdown?

Markdown es un lenguaje de marcado ligero que puedes usar para agregar elementos de formato a documentos de texto plano. Te permite crear texto formateado usando una sintaxis simple y fácil de leer que puede convertirse a HTML y otros formatos.

Piensa en Markdown como una forma de escribir documentos formateados sin necesidad de procesadores de texto complejos. Simplemente agregas caracteres especiales al texto plano para indicar formato como negrita, cursiva, o código.

¿Por qué usar Markdown?

Markdown es increíblemente simple y fácil de aprender. Puedes dominar los conceptos básicos en solo 10 minutos. Los símbolos de formato son intuitivos: asteriscos para énfasis, hashes para encabezados. Solo escribes y agregas símbolos simples para formatear tu texto.

Markdown funciona en cualquier plataforma y cualquier editor de texto. Dado que los archivos son texto plano, siempre serán legibles, incluso décadas en el futuro. Los archivos son ligeros y se cargan rápidamente.

Markdown tiene amplio soporte entre plataformas. GitHub, Reddit, Discord y Slack todos usan Markdown. Aplicaciones populares como Obsidian, Notion y VS Code lo soportan nativamente. Esto lo hace perfecto para documentación, toma de notas y contenido web.

Markdown funciona perfectamente con sistemas de control de versiones como Git. Puedes concentrarte en el contenido sin distracciones de formato. La colaboración en equipo es más fácil porque todos pueden editar archivos sin software especial.

Historia del Desarrollo de Markdown

El Comienzo: Markdown Vanilla (2004)

Markdown fue creado originalmente por John Gruber en 2004, con contribuciones significativas de Aaron Swartz. Gruber lo diseñó para ser una forma simple de escribir usando un formato de texto plano fácil de leer y escribir que pudiera convertirse a HTML estructuralmente válido. Este es el "núcleo" que John Gruber diseñó e implementó inicialmente, conteniendo la sintaxis de formato más básica - lo que llamamos el "sabor básico vanilla".

Sintaxis Básica (Markdown Vanilla incluye):

  • •
    Encabezados: Usar símbolo # (# Encabezado)

  • •
    Énfasis:

  • •
    Cursiva: Usar * o _ para envolver texto (*cursiva* o _cursiva_)
  • •
    Negrita: Usar ** o __ para envolver texto (**negrita** o __negrita__)

  • •
    Listas:

  • •
    Listas no ordenadas: Usar *, -, o + (- elemento)
  • •
    Listas ordenadas: Usar números con puntos (1. elemento)
  • •
    Enlaces: Usar [texto del enlace](dirección del enlace)
  • •
    Imágenes: Usar ![descripción de imagen](dirección de imagen)

  • •
    Bloques de código: Indentar con espacios (usualmente 4 espacios o 1 Tab)

  • •
    Citas: Usar símbolo > (> Esta es una cita)
  • •
    Reglas horizontales: Usar --- o ***

El Problema: Implementaciones Inconsistentes

Sin embargo, Markdown Vanilla carecía de una especificación estricta y formal. Esto llevó a comportamientos inconsistentes entre diferentes analizadores de Markdown al manejar casos límite.

Manejo de espacios en blanco: Por ejemplo, en elementos de lista, ¿cuántos espacios de indentación cuentan como una sub-lista? ¿Son 2 espacios, 3 espacios, o 4 espacios? Diferentes analizadores podrían tener diferentes juicios.

Procesamiento de saltos de línea: En ciertas situaciones, ¿debería un salto de línea regular (\n) ser analizado como una etiqueta <br> (salto de línea), o simplemente tratarse como un espacio en el texto? Esto también puede variar dependiendo del analizador.

Uso mixto de HTML: Markdown permite HTML embebido. Sin embargo, en algunas estructuras HTML complejas, cómo los analizadores de Markdown manejan la sintaxis de Markdown dentro de ellas también presenta áreas ambiguas.

La Solución: CommonMark (2014)

En septiembre de 2014, se introdujo CommonMark para resolver estos problemas de inconsistencia. Liderado por John MacFarlane, proporciona una especificación rigurosa para Markdown.

CommonMark proporciona una especificación precisa donde cada caso límite está claramente definido. Incluye una suite de pruebas comprehensiva con más de 600 casos de prueba para asegurar consistencia entre implementaciones. La especificación proporciona una implementación de referencia que sirve como estándar para que otros analizadores la sigan. Mantiene compatibilidad hacia atrás con la mayoría de documentos Markdown existentes mientras asegura análisis no ambiguo donde la misma entrada siempre produce la misma salida en todos los analizadores compatibles.

Sabores Extendidos y Características Adicionales

A medida que los usuarios tenían diferentes necesidades, varios sabores extendidos de Markdown surgieron para satisfacer requisitos específicos.

Sintaxis Adicional de GitHub Flavored Markdown (GFM):

  • •
    Tablas: Usar sintaxis de pipes para crear tablas
  | Encabezado 1 | Encabezado 2 | Encabezado 3 |
  |--------------|--------------|--------------|
  | Celda 1      | Celda 2      | Celda 3      |
  | Celda 4      | Celda 5      | Celda 6      |
  • •
    Tachado: Usar ~~ para envolver texto (~~texto eliminado~~)

  • •
    Listas de Tareas: Crear casillas de verificación interactivas

  - [x] Tarea completada
  - [ ] Tarea incompleta
  • •
    Bloques de Código Delimitados: Usar comillas invertidas triples con especificación de lenguaje
  ```javascript
  function hello() {
    console.log("Hello World!");
  }
  ```
  • •
    Enlazado Automático: URLs y direcciones de email se vuelven clicables automáticamente

Otras Extensiones Populares:

  • •
    Notas al pie: Usar sintaxis [^1] para escritura académica
  Esta es una oración con una nota al pie[^1].
  [^1]: Este es el contenido de la nota al pie.

Resultado: Esta es una oración con una nota al pie¹.

  • •
    Expresiones Matemáticas: Usar $E=mc^2$ para documentos científicos
  • •
    Atajos de Emoji: Usar :smile: se convierte en 😊

  • •
    Listas de Definición: Para glosarios y documentación técnica

  Término 1
  : Definición para término 1
  
  Término 2
  : Definición para término 2
  : Otra definición para término 2

Resultado: Crea listas formateadas con términos resaltados y definiciones indentadas

¿Cómo Funciona?

Markdown sigue un flujo de trabajo simple de tres pasos:

Paso 1: Crear un Archivo Markdown

Primero, creas un archivo de texto plano con extensión .md o .markdown usando cualquier editor de texto. Escribes tu contenido usando símbolos de formato simples:

Paso 2: Procesar con Herramientas Markdown

Tu archivo .md es entonces procesado por herramientas de conversión Markdown o procesadores. Estas herramientas leen tu archivo Markdown y lo convierten al formato de salida deseado.

Paso 3: Salida a Varios Formatos

El procesador de Markdown puede convertir tu archivo a múltiples formatos:

Para Visualización Web:

  • •
    Convierte a HTML para sitios web, blogs y aplicaciones web

  • •
    Muestra contenido formateado en navegadores con estilos apropiados

Para Documentos:

  • •
    Convierte a PDF para documentos imprimibles e informes

  • •
    Genera documentos Word (.docx) para uso de oficina
  • •
    Crea LaTeX para artículos académicos y publicaciones

Para Publicación:

  • •
    Genera eBooks (formato EPUB)

  • •
    Crea diapositivas de presentación
  • •
    Produce sitios web de documentación

Este flujo de trabajo significa que escribes una vez en Markdown, luego usas diferentes herramientas para convertir tu contenido a cualquier formato que necesites - ya sea mostrarlo en un sitio web, imprimirlo como PDF, o compartirlo como documento.

Recursos Adicionales

Documentación Esencial

  • •
    Documentación de Markdown de John Gruber : La guía original escrita por el creador de Markdown. Lectura esencial para entender la filosofía y sintaxis básica.

  • •
    Wikipedia - Markdown : Descripción general comprehensiva de la historia, variaciones y detalles técnicos de Markdown.

  • •
    Guía Markdown : Una guía comprehensiva y amigable para principiantes con ejemplos y mejores prácticas para todos los niveles de habilidad.