Hinweis
Betrachten Sie ein Callout als einen kleinen, aufmerksamkeitsstarken Spot für Ihre wichtigsten oder interessantesten Inhalte. Es ist wie eine digitale Haftnotiz, die schreit: „Hey, schau mich an!“ Es ist ein vielseitiger Block, der verwendet werden kann, um Tipps, Warnungen, Best Practices oder nahezu alles hervorzuheben, das Sie betonen möchten.
Warum sollten Callouts verwendet werden?
- Wichtige Informationen hervorheben Gibt es etwas besonders Wichtiges, das Ihre Benutzer wissen müssen? Ein Callout ist Ihr Megafon.
- Hilfreiche Tipps bereitstellen Möchten Sie der Held Ihrer Dokumentation sein? Platzieren Sie hilfreiche Tipps in Callouts.
- Vor potenziellen Problemen warnen Verhindern Sie Frustration bei Benutzern, indem Sie Callouts für Warnungen verwenden.
- Einen Hauch von Persönlichkeit hinzufügen Callouts können Ihre Geheimwaffe sein, um Ihren Dokumentationen etwas Persönlichkeit zu verleihen.
😎 Profi-Tipp
Verwenden Sie Callouts sparsam. Zu viele davon und sie verlieren ihre Wirkung. Es ist wie jemanden anzuschreien – es funktioniert eine Zeit lang, wird dann aber einfach nur nervig.
Wie verwendet man den Callout-Block?
Geben Sie / ein, um das Archbee-Blockmenü zu öffnen
Suchen Sie nach dem Block Hinweis und klicken Sie, um ihn einzufügen
Wählen Sie den Callout-Stil
- ℹ️ Info— Für allgemeine Informationen, Tipps oder kurze Fakten.
- ✅ Erfolg— Um Erfolge zu feiern, positive Ergebnisse hervorzuheben oder einfach gute Stimmung zu verbreiten.
- ⚠️ Warnung — Um Benutzer auf potenzielle Probleme, Warnhinweise oder wichtige Überlegungen aufmerksam zu machen.
- 🛑 Gefahr — Für kritische Warnungen, dringende Nachrichten oder Situationen, die sofortige Aufmerksamkeit erfordern.
Sie können gerne Ihre Inhalte hinzufügen. Sie können die Inhalte nach Belieben mit dem WYSIWYG Menu formatieren oder sogar andere Blöcke einfügen, wie z. B.:
- Listen
- Datei
- Bild
- Video
Markdown
Möchten Sie Ihrer Dokumentation Callouts direkt über Markdown hinzufügen? Wir haben die passende Lösung für Sie!
Archbee unterstützt eine spezielle Markdown-Syntax mit dreifachen Doppelpunkten (:::). Mit dieser Methode geben Sie einfach :::hint gefolgt von einem optionalen Stil-Attribut ein, um den Callout-Typ zu definieren (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 freuen, wenn Sie zu @octokit/rest beitragen würden, 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 generieren.
{% hint style="info" %}
some hint
{% endhint %}
Sehen Sie sich die Seite Markdown-Verknüpfungen verwenden an, um weitere Markdown-Verknüpfungen für andere Blöcke zu sehen.
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 Sie nicht schon früher damit angefangen haben?
- ✅ Erfolg
🎉 Sie haben es geschafft!
Sie haben die Kunst der Callouts gemeistert.
Jetzt können Sie großartige Dokumentationen erstellen, die Ihre Konkurrenz in den Schatten stellen.
- ⚠️ Warnung
🚧 Achtung!
Die Verwendung von zu vielen Callouts kann ablenkend wirken. Verwenden Sie sie mit Bedacht, sonst könnten Ihre Leser beginnen, sie komplett zu ignorieren.
- 🛑 Gefahr
🚨 Oh oh!
Wenn Sie das sehen, ist etwas furchtbar schiefgelaufen. 🫣
Wahrscheinlich allerdings nicht bei Archbee, wir sind perfekt. 💅✨
Geben Sie dem Kaffee die Schuld. ☕️
Andere Blöcke finden
Entdecken Sie neue Möglichkeiten und Blöcke, um beeindruckende und funktionale Dokumentationsseiten zu erstellen.
Benötigen Sie Hilfe? ⬇️
Verwenden Sie die blaue Chat-Blase unten rechts.
Oder probieren Sie KI-Chat (aus dem Suchfeld) für schnelle Antworten aus.
Ihre Meinung zählt
Verwenden Sie das untenstehende Feedback-Formular, anonym.
Oder stellen Sie eine Frage im Q&A-Bereich und unser Team oder die AI wird Ihnen eine Lösung geben.