Uitroep
Dink aan ’n uitroep as ’n klein, aandagtrekkende kollig vir u belangrikste of interessantste inhoud. Dit is soos ’n digitale plaknota wat skree, "Haai, kyk na my!". Dit is ’n veelsydige blok wat gebruik kan word om wenke, waarskuwings, beste praktyke of byna enigiets anders wat u wil beklemtoon, uit te lig.
Waarom callouts gebruik?
- Lig Sleutelinligting Uit Is daar iets uiters belangriks wat u gebruikers moet weet? ’n Callout is u megafoon.
- Verskaf Nuttige Wenke Wil u die dokumentasieheld wees? Voeg ’n paar nuttige wenke in callouts by.
- Waarsku Oor Potensiële Probleme Voorkom gebruikers se trane deur callouts vir waarskuwings te gebruik.
- Voeg ’n Tikkie Persoonlikheid By Callouts kan u geheime wapen wees om persoonlikheid in u dokumentasie in te bring.
😎 Pro Wenk
Gebruik callouts spaarsaam. Te veel daarvan en hulle verloor hul impak. Dit is soos om op iemand te skree — dit werk vir ’n rukkie, maar dan raak dit net irriterend.
Hoe om die callout-blok te gebruik?
Tik / om die Archbee-blokkieskieslys oop te maak
Soek vir die Uitroep-blok en klik om dit in te voeg
Kies die callout-styl
- ℹ️ Inligting — Vir algemene inligting, wenke of vinnige feite.
- ✅ Sukses — Om prestasies te vier, positiewe uitkomste uit te lig, of eenvoudig goeie vibes te versprei.
- ⚠️ Waarskuwing — Om gebruikers te waarsku oor potensiële probleme, waarskuwingsnotas of belangrike oorwegings.
- 🛑 Gevaar — Vir kritieke waarskuwings, dringende boodskappe of situasies wat onmiddellike aandag vereis.
Markdown
Wil u callouts direk deur Markdown by u dokumentasie voeg? Ons het u gedek!
Archbee ondersteun 'n spesifieke Markdown-sintaksis met drievoudige dubbelpunte (:::). Met hierdie metode tik u eenvoudig :::hint gevolg deur 'n opsionele styl-attribuut om die callout-tipe te definieer (info, warning, success of danger).
Gebruik die volgende Markdown om 'n callout-blok te genereer:
## 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.
:::Ons sal graag wil hê dat u bydra tot @octokit/rest, pull requests is baie welkom! Sien asseblief CONTRIBUTING.md vir meer inligting.
Alternatiewelik, gebruik hierdie variasie van Markdown om 'n callout-blok te genereer.
{% hint style="info" %}
some hint
{% endhint %}
Kyk na die Gebruik Markdown-kortpaaie bladsy om meer markdown-kortpaaie vir ander blokke te sien.
Voorbeelde
Hier is 'n paar voorbeelde om die callout-blok aan u te wys:
- ℹ️ Inligting
ℹ️ Het u geweet?
Archbee is só goed dat dit u u lewenskeuses sal laat bevraagteken.
Soos, hoekom het u dit nie vroeër begin gebruik nie?
- ✅ Sukses
🎉 U het dit reggekry!
U het die kuns van callouts bemeester.
Gaan nou voort en skep ongelooflike dokumentasie wat u mededingers sal verstom.
- ⚠️ Waarskuwing
🚧 Let op!
Die gebruik van te veel callouts kan steurend wees. Gebruik dit verstandig, anders kan u lesers dit uiteindelik heeltemal begin ignoreer.
- 🛑 Gevaar
🚨 O nee!
As u dit sien, het iets verskriklik verkeerd geloop. 🫣
Waarskynlik nie met Archbee nie, ons is perfek. 💅✨
Blameer die koffie. ☕️
Vind ander blokke
Ontdek nuwe maniere en blokke om pragtige en funksionele dokumentasiebladsye te skep.
Hulp nodig? ⬇️
Gebruik die blou geselsborrel in die onderste regterhoek.
Of probeer KI-klets (vanuit die soekbalk) vir vinnige antwoorde.
U mening maak saak
Gebruik die onderstaande terugvoervorm, anoniem.
Of vra 'n vraag in die Q&A-afdeling en ons span of AI sal u 'n oplossing gee.