NOTE: Esta es una nota en línea.
TIP: Este es un consejo en línea.AsciiDoc ofrece cinco tipos de admoniciones integrados para llamar la atención sobre contenido específico. Toph da estilo a cada tipo como una tarjeta de aviso refinada con un borde izquierdo de color, un fondo con tono suave y un icono.
Tipos de admoniciones 🔗
AsciiDoc define cinco tipos de admoniciones, cada una con un propósito diferente.
Note | Usa las notas para proporcionar contexto adicional o información complementaria que respalde el texto principal. |
Tip | Usa los consejos para compartir buenas prácticas, atajos o recomendaciones que ayuden al lector. |
Warning | Usa las advertencias para alertar al lector sobre posibles problemas o dificultades que debe tener en cuenta. |
Caution | Usa las precauciones para señalar acciones que podrían causar daño, pérdida de datos o consecuencias no deseadas si se realizan sin cuidado. |
Important | Usa las admoniciones importantes para resaltar información crítica que el lector no debe pasar por alto. |
Admoniciones en bloque 🔗
Las admoniciones también pueden abarcar varios párrafos usando la sintaxis de bloque de AsciiDoc. Esto es útil cuando el mensaje necesita más de una oración.
Note | Las admoniciones en bloque usan la sintaxis delimitadora con cuatro signos de igual. Pueden contener varios párrafos, listas y otros elementos de AsciiDoc. Este es un segundo párrafo dentro de la misma admonición. |
Tip | Al escribir documentación, considera qué tipo de admonición se ajusta mejor a tu mensaje.
|
Warning | Las admoniciones deben usarse con moderación. El uso excesivo diluye su impacto y dificulta la lectura rápida del contenido. |
Sintaxis 🔗
Hay dos formas de escribir admoniciones en AsciiDoc.
Sintaxis en línea 🔗
La forma más simple coloca la etiqueta de la admonición al principio de un párrafo:
Sintaxis en bloque 🔗
Para admoniciones de varios párrafos, usa el delimitador de bloque:
[NOTE]
====
Primer párrafo de la admonición.
Segundo párrafo de la admonición.
====