Callout
Piensa en un callout como un pequeño foco de atención para tu contenido más importante o interesante. Es como una nota adhesiva digital que grita, "¡Oye, mírame!". Es un bloque versátil que se puede usar para resaltar consejos, advertencias, buenas prácticas o prácticamente cualquier cosa que quieras enfatizar.
¿Por qué usar callouts?
- Resalta Información Clave ¿Hay algo súper importante que tus usuarios necesiten saber? Un callout es tu megáfono.
- Proporciona Consejos Útiles ¿Quieres ser el héroe de la documentación? Deja algunos consejos útiles en los callouts.
- Advertir sobre posibles problemas Evita lágrimas del usuario usando avisos para advertencias.
- Agrega un toque de personalidad Los avisos pueden ser tu arma secreta para añadir algo de personalidad a tu documentación.
😎 Consejo profesional
Usa los avisos con moderación. Demasiados y pierden su impacto. Es como gritarle a alguien: funciona por un tiempo, pero luego solo se vuelve molesto.
¿Cómo usar el bloque de aviso?
Escribe / para abrir el menú de bloques de Archbee
Busca el bloque Callout y haz clic para insertarlo
Elige el estilo del callout
- ℹ️ Información — Para información general, consejos o datos rápidos.
- ✅ Éxito — Para celebrar logros, resaltar resultados positivos o simplemente transmitir buenas vibras.
- ⚠️ Advertencia — Para alertar a los usuarios sobre posibles problemas, notas de precaución o consideraciones importantes.
- 🛑 Peligro — Para alertas críticas, mensajes urgentes o situaciones que requieren atención inmediata.
Markdown
¿Quieres agregar avisos a tu documentación directamente a través de Markdown? ¡Te tenemos cubierto!
Archbee admite una sintaxis específica de Markdown con triple dos puntos (:::). Con este método, simplemente escribes :::hint seguido de un atributo opcional style para definir el tipo de aviso (info, warning, success o danger).
Utiliza el siguiente Markdown para generar un bloque de aviso:
## Hints
:::hint{style="info"}
We would love you to contribute to `@octokit/rest`, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
:::
:::hint{style="warning"}
We would love you to contribute to `@octokit/rest`, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
:::
:::hint{style="success"}
We would love you to contribute to `@octokit/rest`, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
:::
:::hint{style="danger"}
We would love you to contribute to `@octokit/rest`, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
:::Nos encantaría que contribuyeras a @octokit/rest, ¡las pull requests son muy bienvenidas! Por favor, revisa CONTRIBUTING.md para más información.
Alternativamente, utiliza esta variación de Markdown para generar un bloque de aviso.
{% hint style="info" %}
some hint
{% endhint %}
Consulta la Usar atajos de Markdown página para ver más atajos de markdown para otros bloques.
Ejemplos
Aquí hay algunos ejemplos para mostrarte el bloque de aviso:
- ℹ️ Información
ℹ️ ¿Lo sabías?
Archbee es tan bueno que te hará cuestionar tus decisiones de vida.
Como, ¿por qué no comenzaste a usarlo antes?
- ✅ Éxito
🎉 ¡Lo lograste!
Has dominado el arte de los avisos.
Ahora ve y crea documentación increíble que dejará a tus competidores asombrados.
- ⚠️ Advertencia
🚧 ¡Atención!
Usar demasiados avisos puede ser distractor. Úsalos con prudencia, o tus lectores podrían empezar a ignorarlos por completo.
- 🛑 Peligro
🚨 ¡Uy!
Si estás viendo esto, algo ha salido terriblemente mal. 🫣
Probablemente no con Archbee, somos perfectos. 💅✨
Culpa al café. ☕️
Encontrar otros bloques
Descubre nuevas formas y bloques para crear páginas de documentación impresionantes y funcionales.
¿Necesitas ayuda? ⬇️
Usa la burbuja de chat azul en la esquina inferior derecha.
O prueba Chat IA (desde la caja de búsqueda) para respuestas rápidas.
Tu opinión importa
Usa el formulario de comentarios de abajo, de forma anónima.
O haz una pregunta en la sección de Preguntas y Respuestas y nuestro equipo o la IA te dará una solución.