Kehotus
Ajatelkaa calloutia pienenä, huomiota herättävänä kohdevalona tärkeimmälle tai kiinnostavimmalle sisällöllenne. Se on kuin digitaalinen tarralappu, joka huutaa "Hei, katsokaa minua!". Se on monipuolinen lohko, jota voidaan käyttää vinkkien, varoitusten, parhaiden käytäntöjen tai melkein minkä tahansa korostettavan asian esiin tuomiseen.
Miksi käyttää callouteja?
- Korostakaa keskeisiä tietoja Onko jotain todella tärkeää, joka käyttäjienne täytyy tietää? Callout toimii megafoninanne.
- Tarjotkaa hyödyllisiä vinkkejä Haluatteko olla dokumentaation sankari? Lisätkää hyödyllisiä vinkkejä callouteihin.
- Varoittakaa mahdollisista ongelmista Estäkää käyttäjien turhautuminen käyttämällä callouteja varoituksiin.
- Lisätkää ripaus persoonallisuutta Calloutit voivat olla salainen aseenne persoonallisuuden lisäämiseen dokumentaatioonne.
😎 Ammattilaisvinkki
Käyttäkää callouteja säästeliäästi. Liian moni niistä menettää vaikutuksensa. Se on kuin huutaisi jollekulle – se toimii hetken aikaa, mutta muuttuu sitten vain ärsyttäväksi.
Kuinka callout-lohkoa käytetään?
Kirjoita / avataksesi Archbee-lohkovalikon
Etsi Huomautus-lohko ja lisää se napsauttamalla
Valitse callout-tyyli
- ℹ️ Tietoa— Yleisiä tietoja, vinkkejä tai nopeita faktoja varten.
- ✅ Onnistui — Saavutusten juhlistamiseen, positiivisten tulosten korostamiseen tai yksinkertaisesti hyvän tunnelman levittämiseen.
- ⚠️ Varoitus — Käyttäjien varoittamiseen mahdollisista ongelmista, varoitushuomautuksista tai tärkeistä huomioista.
- 🛑 Vaara — Kriittisiä hälytyksiä, kiireellisiä viestejä tai välitöntä huomiota vaativia tilanteita varten.
Markdown
Haluatko lisätä callouteja dokumentaatioosi suoraan Markdownin kautta? Me hoidamme asian!
Archbee tukee erityistä Markdown-syntaksia, jossa käytetään kolmoispisteitä (:::). Tällä menetelmällä kirjoitat yksinkertaisesti :::vihje ja sen jälkeen valinnaisen tyyli-attribuutin määrittääksesi callout-tyypin (info, warning, success tai danger).
Käytä seuraavaa Markdownia callout-lohkon luomiseen:
## 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.
:::Haluaisimme kovasti, että osallistuisitte projektiin @octokit/rest, pull requestit ovat erittäin tervetulleita! Katso lisätietoja tiedostosta CONTRIBUTING.md.
Vaihtoehtoisesti voitte käyttää tätä Markdown-muotoa luodaksenne callout-lohkon.
{% hint style="info" %}
some hint
{% endhint %}
Katso sivu Käytä Markdown-pikakomentoja nähdäksenne lisää markdown-pikakomentoja muille lohkoille.
Esimerkit
Tässä on joitakin esimerkkejä, jotka näyttävät callout-lohkon:
- ℹ️ Tiedote
ℹ️ Tiesittekö?
Archbee on niin hyvä, että se saa teidät kyseenalaistamaan elämänvalintanne.
Esimerkiksi miksi ette aloittaneet sen käyttöä aiemmin?
- ✅ Onnistui
🎉 Onnistuitte!
Olette hallinneet callout-lohkojen taidon.
Nyt voitte luoda upeaa dokumentaatiota, joka jättää kilpailijanne kauas taakse.
- ⚠️ Varoitus
🚧 Huomio!
Liian monien callout-lohkojen käyttö voi häiritä. Käyttäkää niitä harkiten, tai lukijanne saattavat alkaa sivuuttaa ne kokonaan.
- 🛑 Vaara
🚨 Oho!
Jos näette tämän, jokin on mennyt pahasti pieleen. 🫣
Todennäköisesti ei kuitenkaan Archbeen kanssa, olemme täydellisiä. 💅✨
Syyttäkää kahvia. ☕️
Löydä muita lohkoja
Tutustukaa uusiin tapoihin ja lohkoihin luodaksenne näyttäviä ja toiminnallisia dokumentaatiosivuja.
Tarvitsetteko apua? ⬇️
Käyttäkää sinistä chat-kuplaa oikeasta alakulmasta.
Tai kokeilkaa Tekoälykeskustelu-toimintoa (hakukentästä) saadaksenne nopeita vastauksia.
Mielipiteenne on tärkeä
Käyttäkää alla olevaa palautelomaketta anonyymisti.
Tai esittäkää kysymys Q&A-osiossa ja tiimimme tai AI antaa teille ratkaisun.