Avertissement
Pensez à un encadré comme un petit projecteur recherchant l’attention pour votre contenu le plus important ou le plus intéressant. C’est comme un pense-bête numérique qui crie, « Hé, regardez-moi ! ». C’est un bloc polyvalent pouvant être utilisé pour mettre en avant des conseils, des avertissements, des bonnes pratiques, ou à peu près tout ce que vous souhaitez souligner.
Pourquoi utiliser des callouts ?
- Mettre en évidence les informations clés Y a-t-il quelque chose de très important que vos utilisateurs doivent connaître ? Un callout est votre mégaphone.
- Fournir des conseils utiles Vous souhaitez devenir le héros de la documentation ? Ajoutez quelques conseils utiles dans des callouts.
- Avertir des problèmes potentiels Évitez les larmes des utilisateurs en utilisant des callouts pour les avertissements.
- Ajouter une touche de personnalité Les callouts peuvent être votre arme secrète pour injecter un peu de personnalité dans votre documentation.
😎 Astuce pro
Utilisez les callouts avec parcimonie. Trop nombreux, ils perdent leur impact. C’est comme crier sur quelqu’un : cela fonctionne un moment, puis cela devient simplement agaçant.
Comment utiliser le bloc callout ?
Tapez / pour ouvrir le menu des blocs Archbee
Recherchez le bloc Encadré et cliquez pour l’insérer
Choisissez le style de callout
- ℹ️ Infos — Pour des informations générales, des conseils ou des faits rapides.
- ✅ Succès — Pour célébrer des réussites, mettre en avant des résultats positifs ou simplement diffuser de bonnes ondes.
- ⚠️ Avertissement — Pour avertir les utilisateurs de problèmes potentiels, de notes de prudence ou de considérations importantes.
- 🛑 Danger — Pour des alertes critiques, des messages urgents ou des situations nécessitant une attention immédiate.
Markdown
Vous souhaitez ajouter des callouts à votre documentation directement via Markdown ? Nous avons ce qu’il vous faut !
Archbee prend en charge une syntaxe Markdown spécifique avec trois deux-points (:::). Avec cette méthode, vous tapez simplement :::hint suivi d’un attribut optionnel style pour définir le type de callout (info, warning, success ou danger).
Utilisez le Markdown suivant pour générer un bloc 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.
:::Nous serions ravis que vous contribuiez à @octokit/rest, les pull requests sont les bienvenues! Veuillez consulter CONTRIBUTING.md pour plus d’informations.
Vous pouvez également utiliser cette variante de Markdown pour générer un bloc d’avertissement.
{% hint style="info" %}
some hint
{% endhint %}
Consultez la page Utiliser les raccourcis Markdown pour découvrir davantage de raccourcis Markdown pour d’autres blocs.
Exemples
Voici quelques exemples pour vous montrer le bloc d’avertissement :
- ℹ️ Informations
ℹ️ Le saviez-vous?
Archbee est tellement performant qu’il vous fera remettre en question vos choix de vie.
Comme, pourquoi ne l’avez-vous pas utilisé plus tôt?
- ✅ Succès
🎉 Vous y êtes arrivé!
Vous avez maîtrisé l’art des blocs d’avertissement.
Maintenant, allez créer une documentation incroyable qui surpassera celle de vos concurrents.
- ⚠️ Avertissement
🚧 Attention!
L’utilisation excessive de blocs peut être distrayante. Utilisez-les judicieusement, sinon vos lecteurs pourraient finir par les ignorer complètement.
- 🛑 Danger
🚨 Oh-oh!
Si vous voyez ceci, quelque chose s’est très mal passé. 🫣
Probablement pas avec Archbee cependant, nous sommes parfaits. 💅✨
Blâmez le café. ☕️
Trouver d’autres blocs
Découvrez de nouvelles manières et de nouveaux blocs pour créer des pages de documentation superbes et fonctionnelles.
Besoin d’aide? ⬇️
Utilisez la bulle de discussion bleue dans le coin inférieur droit.
Ou essayez Chat IA (depuis la barre de recherche) pour obtenir des réponses rapides.
Votre avis compte
Utilisez le formulaire de rétroaction ci-dessous, anonymement.
Ou posez une question dans la section Q&A et notre équipe ou l’IA vous fournira une solution.