Admoniciones
Una admonición es un bloque de texto destacado que se utiliza para resaltar información importante. Por ejemplo, si escribimos en el archivo markdown:
> **Nota**<hr>
> Esta es una información importante
> que no se debe pasar por alto.
Obtendremos lo siguiente:
Nota
Esta es una información importante que no se debe pasar por alto.
mdBook proporciona un estilo especial de admoniciones. Consiste en añadir
una primera línea con el tipo de admonición entre corchetes y con un prefijo !
> [!NOTE]
> Información general o de contexto.
> [!TIP]
> Una sugerencia útil o mejor práctica.
> [!IMPORTANT]
> Información clave que no debe perderse.
> [!WARNING]
> Información crítica que destaca un riesgo potencial.
> [!CAUTION]
> Información sobre posibles problemas que requieren precaución.
Lo que muestra:
Note
Información general o de contexto.
Tip
Una sugerencia útil o mejor práctica.
Important
Información clave que no debe perderse.
Warning
Información crítica que destaca un riesgo potencial.
Caution
Información sobre posibles problemas que requieren precaución.
Pero esta funcionalidad tiene una carencia que, en el momento de escribir esto, sigue sin resolverse. No es posible mostrar las cabeceras traducidas a otros lenguajes. Se muestran en inglés: “Note”, “Tip”, “Warning”, etcétera.
Añadiendo iconos
Una alternativa es usar entidades HTML para añadir un icono al título de la admonición:
> <span style="color:red;font-size:2em;font-weight:bold;"> ⚠ </span>
> **¡Cuidado!** <hr>
> Esta es una información importante
> que no se debe pasar por alto.
Lo que muestra:
⚠ ¡Cuidado!
Esta es una información importante que no se debe pasar por alto.
Encerramos el carácter ⚠ entre etiquetas <span> para delimitar
el bloque al que deseamos aplicar reglas de estilo:
- color rojo
- doble tamaño de texto
- resaltado en negrita
Otra solución es insertar un icono, como se explicó anteriormente:
- =
<i class="fa-solid fa-triangle-exclamation"></i> - =
<i class="fa-solid fa-circle-exclamation"></i> - =
<i class="fa-solid fa-circle-info"></i> - =
<i class="fa-regular fa-circle-xmark"></i> - =
<i class="fa-regular fa-lightbulb"></i> - =
<i class="fa-regular fa-circle-check"></i> - =
<i class="fa-solid fa-circle-radiation"></i>
Por ejemplo:
> <span style="font-size:2em; color:red"><i class="fa-solid fa-triangle-exclamation"></i></span>> **¡Cuidado!** <hr>
> Esta es una información importante
> que no se debe pasar por alto.
Lo que muestra:
¡Cuidado!
Esta es una información importante que no se debe pasar por alto.
Extensiones
Las carencias de mdBook se pueden solucionar instalando complementos desarrollados por terceras personas.
Estos complementos son programas que, una vez instalados, se ejecutan durante el proceso de conversión a HTML, transformando (preprocesando) el texto markdown. Se denominan “preprocesadores” y hay una lista en la página de mdBook.
Podemos descargar e instalar el complemento mdbook-admonish, que proporciona admoniciones más elaboradas. Pero la instalación de extensiones suele implicar tener que descargar los programas fuente, en formato de texto y compilarlos a formato binario con las herramientas de desarrollo Rust que tengamos en nuestro equipo. Dejaremos esa tarea para los usuarios programadores de Rust.