Hinweis
Stellen Sie sich einen Callout als einen kleinen, aufmerksamkeitsstarken Spot für Ihre wichtigsten oder interessantesten Inhalte vor. Es ist wie ein digitales Klebezettelchen, das ruft: "Hey, schau mich an!". Es ist ein vielseitiger Block, der verwendet werden kann, um Tipps, Warnungen, Best Practices oder so ziemlich alles hervorzuheben, was Sie betonen möchten.
Warum Callouts verwenden?
- Wichtige Informationen hervorheben Gibt es etwas besonders Wichtiges, das Ihre Benutzer wissen müssen? Ein Callout ist Ihr Megafon.
- Hilfreiche Tipps geben Wollen Sie der Held der Dokumentation sein? Platzieren Sie hilfreiche Tipps in Callouts.
- Vor möglichen Problemen warnen Verhindern Sie Benutzertränen, indem Sie Callouts für Warnungen verwenden.
- Einen Hauch Persönlichkeit hinzufügen Callouts können Ihre Geheimwaffe sein, um etwas Persönlichkeit in Ihre Dokumentation zu bringen.
😎 Profi-Tipp
Verwenden Sie Callouts sparsam. Zu viele davon verlieren ihre Wirkung. Es ist wie jemanden anzuschreien – es funktioniert eine Weile, aber dann wird es einfach nervig.
Wie verwendet man den Callout-Block?
Geben Sie / ein, um das Archbee-Blockmenü zu öffnen
Suchen Sie nach dem Hinweis-Block und klicken Sie, um ihn einzufügen
Wählen Sie den Callout-Stil aus
- ℹ️ Info — Für allgemeine Informationen, Tipps oder kurze Hinweise.
- ✅ Erfolg — Um Erfolge zu feiern, positive Ergebnisse hervorzuheben oder einfach gute Stimmung zu verbreiten.
- ⚠️ Warnung — Um Benutzer auf potenzielle Probleme, Vorsichtsmaßnahmen oder wichtige Hinweise aufmerksam zu machen.
- 🛑 Gefahr — Für kritische Warnungen, dringende Mitteilungen oder Situationen, die sofortige Aufmerksamkeit erfordern.
Markdown
Möchten Sie Callouts direkt über Markdown zu Ihrer Dokumentation hinzufügen? Kein Problem!
Archbee unterstützt eine spezielle Markdown-Syntax mit drei Doppelpunkten (:::). Mit dieser Methode geben Sie einfach :::hint ein, gefolgt von einem optionalen Stil-Attribut, um den Callout-Typ festzulegen (info, warning, success oder danger).
Verwenden Sie das folgende Markdown, um einen Callout-Block zu erzeugen:
## 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.
:::Wir würden uns sehr freuen, wenn Sie zu @octokit/rest, beitragen – Pull Requests sind sehr willkommen! Weitere Informationen finden Sie in CONTRIBUTING.md.
Alternativ können Sie diese Markdown-Variante verwenden, um einen Callout-Block zu erstellen.
{% hint style="info" %}
some hint
{% endhint %}
Sehen Sie sich die Seite Markdown‑Kurzbefehle verwenden an, um weitere Markdown-Shortcuts für andere Blöcke zu entdecken.
Beispiele
Hier sind einige Beispiele, um Ihnen den Callout-Block zu zeigen:
- ℹ️ Info
ℹ️ Wussten Sie schon?
Archbee ist so gut, dass Sie Ihre Lebensentscheidungen hinterfragen werden.
Zum Beispiel: Warum haben Sie es nicht schon früher benutzt?
- ✅ Erfolg
🎉 Sie haben es geschafft!
Sie haben die Kunst der Callouts gemeistert.
Jetzt erstellen Sie großartige Dokumentation, die Ihre Konkurrenz aus dem Wasser bläst.
- ⚠️ Warnung
🚧 Achtung!
Zu viele Callouts können ablenken. Verwenden Sie sie mit Bedacht, sonst ignorieren Ihre Leser sie möglicherweise komplett.
- 🛑 Gefahr
🚨 Oh-oh!
Wenn Sie das hier sehen, ist etwas furchtbar schiefgelaufen. 🫣
Wahrscheinlich jedoch nicht mit Archbee, wir sind perfekt. 💅✨
Geben Sie dem Kaffee die Schuld. ☕️
Weitere Blöcke finden
Entdecken Sie neue Möglichkeiten und Blöcke, um beeindruckende und funktionale Dokumentationsseiten zu erstellen.
Brauchen Sie Hilfe? ⬇️
Verwenden Sie die blaue Chat-Blase in der unteren rechten Ecke.
Oder versuchen Sie KI-Chat (über das Suchfeld) für schnelle Antworten.
Ihre Meinung zählt
Nutzen Sie das untenstehende anonyme Feedback-Formular.
Oder stellen Sie eine Frage im Abschnitt Q&A – unser Team oder die KI gibt Ihnen eine Lösung.