Zum Inhalt springen
Das ist die Dokumentation für Clay 4.x. Zur neuesten Version (5.x)
Auf dieser Seite

Markdown

Clay liest Clay Flavored Markdown (CFM): GitHub Flavored Markdown, das Markdown aus READMEs und Issues auf GitHub, plus Hinweise, Komponenten, Formeln und Diagramme. Alles, was GitHub zeigt, funktioniert auch in Clay, und was Clay ergänzt, bleibt auf GitHub lesbar. Jedes Element unten zeigt sein Ergebnis und seinen Quelltext; wähl einmal Markdown, um überall den Quelltext zu sehen.

#Überschriften

## Ein Abschnitt
### Ein Unterabschnitt

# ist die Überschrift der Seite; nutze sie einmal pro Seite. ##- und ###-Überschriften erscheinen im Inhaltsverzeichnis und werden zu eigenen Suchergebnissen. Jede Überschrift bekommt einen Anker, gebildet wie auf GitHub, damit du auf einen Abschnitt verlinken kannst: Die Überschrift „Zeilenumbrüche“ unten erreichst du als #zeilenumbrüche. Fährst du über eine Abschnittsüberschrift, erscheint links ein #-Link zum Kopieren.

#Hervorhebung

fett, kursiv, durchgestrichen und Code im Text

#Zeilenumbrüche

Ein Zeilenumbruch im Text ist ein Zeilenumbruch auf der Seite, wie in GitHub-Kommentaren. Trenne Absätze mit einer leeren Zeile.

Erste Zeile
zweite Zeile, im selben Absatz

Ein neuer Absatz

Tipp

Schreib jeden Absatz in eine Zeile und lass deinen Editor umbrechen. Von Hand umbrochene Absätze zeigen ihre Umbrüche auf der Seite.

#Listen

  • Kaffee
  • Tee
    • Grüner Tee
    • Schwarzer Tee
  1. Installieren
  2. Konfigurieren
  3. Bauen

Für Anleitungen in einer Reihenfolge zeigen Schritte eine nummerierte Liste als Anleitung.

#Aufgabenlisten

#Tabellen

Spalten lassen sich mit Doppelpunkten in der Trennzeile links, mittig oder rechts ausrichten:

Befehl Port Zweck
dev 3000 schreiben
preview 4173 prüfen

#Zitate

Dokumentation ist ein Liebesbrief an dein zukünftiges Ich.

Ein Zitat, das mit [!NOTE], [!TIP] oder ähnlichem beginnt, wird zu einem Hinweis.

#Waagerechte Linien

Drei Bindestriche in einer eigenen Zeile ziehen eine Linie über die Seite:

---

#Mehr als Markdown