Markdown.es Logo Markdown.es

¿Te es útil esta web? Apóyala sin coste: si compras en Amazon, hazlo a través de nuestro enlace de afiliado — el precio es el mismo para ti y nos ayuda a seguir.

Abreviaciones en Markdown: definir siglas con Multimarkdown

Cómo definir abreviaciones y siglas en Markdown para que se expliquen solas al pasar el ratón. Sintaxis de Multimarkdown, la etiqueta abbr de HTML y qué hacer cuando no hay soporte.

Si tu texto usa siglas, tienes un problema recurrente: explicarlas cada vez molesta a quien ya las conoce, y no explicarlas deja fuera a quien no.

Multimarkdown lo resuelve con las abreviaciones: las defines una vez y el procesador se encarga de que cada aparición muestre su significado al pasar el ratón.

Sintaxis

Un asterisco, el término entre corchetes, dos puntos y la explicación:

MMD ofrece muchas más posibilidades que MD.

*[MMD]: Abreviación para Multimarkdown
*[MD]: Abreviación para Markdown

Resultado — pasa el ratón por encima de las siglas:

MMD ofrece muchas más posibilidades que MD.

La estructura es idéntica a la de los enlaces de referencia, solo que precedida de un asterisco. Y como en aquellos, la definición no aparece en el resultado: desaparece al procesarse.

Qué genera

Cada aparición del término se envuelve en la etiqueta HTML <abbr>:

<abbr title="Abreviación para Multimarkdown">MMD</abbr>

Esa etiqueta tiene tres efectos reales:

  • Visual — los navegadores suelen marcarla con un subrayado punteado.
  • Al pasar el ratón — muestra el title como tooltip.
  • Accesibilidad — los lectores de pantalla pueden anunciar el significado completo en lugar de deletrear las siglas.

Ese tercer punto es el que de verdad justifica usarlas.

Detalles que conviene saber

Se sustituyen todas las apariciones, no solo la primera. Si MD sale quince veces, las quince quedan marcadas.

Distingue mayúsculas. MMD y mmd son términos distintos. Si usas ambas grafías, define las dos.

Solo coincide con palabras completas. MD no marca el MD dentro de MMD.

Las definiciones pueden ir en cualquier parte del documento: al principio, al final o repartidas. Lo habitual es agruparlas al final para no ensuciar el texto.

No pongas la explicación entre paréntesis además. Escribir MMD (Multimarkdown) con la abreviación definida es redundante: expande dos veces. Elige una.

Compatibilidad

Es de lo menos soportado de Multimarkdown:

PlataformaAbreviaciones
Multimarkdown
Pandoc
Python-Markdown (extensión abbr)
Typora
GitHub
Obsidian
Notion
CommonMark

⚠️ En GitHub no funcionan. Verás la línea *[MMD]: Abreviación para Multimarkdown como texto normal en mitad del documento, lo cual queda claramente a la vista. No las uses en un README.

Las alternativas

HTML en línea — funciona en cualquier procesador que admita HTML, que son casi todos:

<abbr title="Abreviación para Multimarkdown">MMD</abbr>

Más verboso y hay que repetirlo en cada aparición, pero es la vía portable. Para un documento con dos o tres siglas repetidas pocas veces, es la opción sensata.

Explicarla la primera vez — la solución de toda la vida, y perfectamente válida: “Multimarkdown (MMD) añade…”. No depende de ninguna extensión y funciona hasta en texto plano.

Una lista de definiciones — si tienes muchas siglas, un glosario al principio o al final del documento con listas de definiciones suele ser más útil que un tooltip que hay que descubrir pasando el ratón. En móvil, además, no hay ratón que pasar.

Ese último punto merece pensarse: en pantallas táctiles el title no se muestra. Si tu texto se lee sobre todo en móvil, las abreviaciones aportan poco más que la semántica de accesibilidad.

Pruébalo

Comprueba si tu procesador genera la etiqueta <abbr> pegando el texto en el previsualizador de Markdown.