Zum Inhalt springen
Das ist die Dokumentation für Clay 3.x. Zur neuesten Version (5.x)
Weitere Möglichkeiten mit dieser Seite

Schreiben

Alles rund um den Inhalt einer Seite: Markdown, Codeblöcke, Hinweise, Links, Bilder und HTML.

Jede Seite ist eine Markdown-Datei in docs/. Clay versteht das Markdown, das du von GitHub kennst, ergänzt Syntaxhervorhebung und Hinweisboxen und prüft bei jedem Build deine Links.

Wenn du … willst Lies
Wissen, wie aus einer Datei eine Seite wird und woher ihr Titel kommt Seiten
Überschriften, Listen, Tabellen und Aufgabenlisten nachschlagen Markdown
Code mit Hervorhebung, Diffs und Kopierknopf zeigen Codeblöcke
Eine Notiz, einen Tipp oder eine Warnung einfügen Hinweise
Auf andere Seiten und Abschnitte verlinken oder Bilder einfügen Links & Bilder
HTML nutzen, wo Markdown nicht reicht HTML

#Das Wichtigste

  • Eine Datei, eine Seite. Aus docs/guides/setup.md wird /guides/setup.
  • Links funktionieren wie auf GitHub. Verlinke die .md-Datei; Clay macht daraus die URL der Seite und meldet Links, die ins Leere führen.
  • Dateien neben deinen Seiten werden mitveröffentlicht. Bilder und Downloads in docs/ behalten ihre relativen Pfade.

In diesem Abschnitt