Auf dieser Seite
Hinweise
Hinweise heben wichtige Informationen hervor. Sie nutzen die Hinweis-Syntax von GitHub: ein Zitat, dessen erste Zeile die Art des Hinweises nennt.
> [!NOTE]
> Clay ignoriert Dateien, deren Name mit einem Punkt beginnt.Hinweis
Clay ignoriert Dateien, deren Name mit einem Punkt beginnt.
#Alle Arten
Hinweis
Hintergrundwissen, das Leser auch beim Überfliegen bemerken sollen.
Tipp
Eine Abkürzung oder ein besserer Weg, etwas zu tun.
Wichtig
Etwas, das Leser wissen müssen, um ans Ziel zu kommen.
Warnung
Etwas, das schiefgehen kann und Aufmerksamkeit braucht.
Vorsicht
Die Folgen einer Aktion, etwa Datenverlust.
Gefahr
Ein ernstes Risiko. DANGER ist eine Ergänzung von Clay; GitHub zeigt es als normales Zitat.
Die Bezeichnungen wie [!NOTE] schreibst du in jeder Sprache englisch; die Überschrift im Kasten erscheint in der Sprache der Seite, hier also „Hinweis“.
#Inhalt in Hinweisen
Hinweise können alles enthalten, was ein Zitat enthalten kann: mehrere Absätze, Listen, Links und Code.
> [!WARNING]
> Eine Seite umzubenennen ändert ihre URL. Bevor du eine umbenennst:
>
> - suche in der Dokumentation nach Links darauf,
> - aktualisiere Links von anderen Websites, wenn du kannst.
>
> `npx clay build --strict` findet kaputte Links.Warnung
Eine Seite umzubenennen ändert ihre URL. Bevor du eine umbenennst:
- suche in der Dokumentation nach Links darauf,
- aktualisiere Links von anderen Websites, wenn du kannst.
npx clay build --strict findet kaputte Links.
Tipp
Setze Hinweise sparsam ein. Auf einer Seite voller Hinweise sticht keiner mehr heraus.