Callout
Piense en un aviso como un pequeño foco de atención para su contenido más importante o interesante. Es como una nota adhesiva digital que grita, "¡Oiga, míreme!". Es un bloque versátil que puede utilizarse para resaltar consejos, advertencias, buenas prácticas o prácticamente cualquier cosa que desee enfatizar.
¿Por qué utilizar callouts?
- Resaltar información clave ¿Hay algo extremadamente importante que sus usuarios necesiten saber? Un callout es su megáfono.
- Proporcionar consejos útiles ¿Quiere ser el héroe de la documentación? Ofrezca algunos consejos útiles en callouts.
- Advertir sobre posibles problemas Evite lágrimas de los usuarios utilizando callouts para advertencias.
- Agregar un toque de personalidad Los callouts pueden ser su arma secreta para inyectar algo de personalidad en su documentación.
😎 Consejo Profesional
Utilice los callouts con moderación. Demasiados y perderán su impacto. Es como gritarle a alguien: funciona por un tiempo, pero luego simplemente se vuelve molesto.
¿Cómo usar el bloque de callout?
Escriba / para abrir el menú de bloques de Archbee
Busque el bloque Aviso y haga clic para insertarlo
Elija 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
¿Desea agregar callouts a su documentación directamente mediante Markdown? ¡Tenemos lo que necesita!
Archbee admite una sintaxis específica de Markdown con triple dos puntos (:::). Con este método, simplemente escriba :::hint seguido de un atributo opcional estilo para definir el tipo de callout (info, warning, success o danger).
Use el siguiente Markdown para generar un bloque de callout:
## 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 contribuyera a @octokit/rest, las pull requests son muy bienvenidas. Consulte CONTRIBUTING.md para obtener más información.
Como alternativa, utilice esta variante de Markdown para generar un bloque de aviso.
{% hint style="info" %}
some hint
{% endhint %}
Consulte la página Usar atajos de Markdown para ver más accesos directos Markdown para otros bloques.
Ejemplos
Aquí hay algunos ejemplos para mostrarle el bloque de aviso:
- ℹ️ Información
ℹ️ ¿Sabía esto?
Archbee es tan bueno que le hará cuestionarse sus decisiones de vida.
Como, ¿por qué no empezó a usarlo antes?
- ✅ Éxito
🎉 ¡Lo logró!
Ha dominado el arte de los avisos.
Ahora continúe y cree documentación increíble que dejará a sus competidores fuera del agua.
- ⚠️ Advertencia
🚧 ¡Atención!
Usar demasiados avisos puede ser una distracción. Úselos con prudencia, o sus lectores podrían empezar a ignorarlos por completo.
- 🛑 Peligro
🚨 ¡Vaya!
Si está viendo esto, algo ha salido terriblemente mal. 🫣
Probablemente no con Archbee, somos perfectos. 💅✨
Culpe al café. ☕️
Encontrar otros bloques
Descubra nuevas formas y bloques para crear páginas de documentación impresionantes y funcionales.
¿Necesita ayuda? ⬇️
Utilice la burbuja de chat azul en la esquina inferior derecha.
O pruebe Chat de IA (desde la caja de búsqueda) para obtener respuestas rápidas.
Su opinión importa
Utilice el siguiente formulario de comentarios, de forma anónima.
O haga una pregunta en la sección de Preguntas y Respuestas y nuestro equipo o la IA le dará una solución.