<Admonition />

Admonition Component

El uso del componente <Admonition /> es para resaltar un texto con un ícono en la parte superior. Un ejemplo de uso es el siguiente:

<Admonition icon='👋'>Welcome a la documentación.</Admonition>

👋info

Welcome a la documentación.

Custom Admonition

Nuestro caso, customizamos el componente para que tenga otros colores e iconos que querramos mediante un Emoji o FontAwesome.

Si quieren conocer más cómo hacer un Admonition personalizado, pueden visitar la documentación de Docusaurus.

Esta es la lista de colores que se pueden usar con los iconos por defecto del componente:

<Admonition type="gold" title="Gold">
  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus accumsan.</p>
</Admonition>
<Admonition type="purple" title="Purple">
  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus accumsan.</p>
</Admonition>
<Admonition type="teal" title="Teal">
  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus accumsan.</p>
</Admonition>
<Admonition type="red" title="Red">
  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus accumsan.</p>
</Admonition>
<Admonition type="green" title="Green">
  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus accumsan.</p>
</Admonition>
<Admonition type="grey" title="Grey">
  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus accumsan.</p>
</Admonition>
<Admonition type="gold" icon={<FAIcon icon="fa-brands fa-github" />} title="GitHub">
  <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus accumsan.</p>
</Admonition>

Gold