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

Markdown

Clay liest GitHub Flavored Markdown, das Markdown, das du aus READMEs und Issues auf GitHub kennst. Diese Seite zeigt jedes Element mit Quelltext und Ergebnis.

#Ü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“ weiter unten erreichst du über #zeilenumbrüche. Fährst du mit der Maus über eine Abschnittsüberschrift, erscheint links ein #-Link darauf, bereit zum Kopieren.

#Hervorhebungen

**fett**, *kursiv*, ~~durchgestrichen~~ und `Code im Text`

fett, kursiv, durchgestrichen und Code im Text

#Zeilenumbrüche

Ein Zeilenumbruch in deinem Text ist ein Zeilenumbruch auf der Seite, wie in Kommentaren auf GitHub. Absätze trennst du mit einer Leerzeile.

Erste Zeile
zweite Zeile, im selben Absatz

Ein neuer Absatz

Erste Zeile
zweite Zeile, im selben Absatz

Ein neuer Absatz

Tipp

Schreib jeden Absatz in deinem Editor in eine Zeile und lass ihn den Text umbrechen. Fest umbrochene Absätze zeigen ihre Zeilenumbrüche auf der Seite.

#Listen

- Kaffee
- Tee
  - Grüner Tee
  - Schwarzer Tee

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

#Aufgabenlisten

- [x] Dokumentation schreiben
- [x] Seite bauen
- [ ] Veröffentlichen

#Tabellen

Spalten richtest du mit Doppelpunkten in der Trennzeile links, mittig oder rechts aus:

| Befehl  | Port | Zweck     |
|:--------|:----:|----------:|
| dev     | 3000 | schreiben |
| preview | 4173 | prüfen    |
Befehl Port Zweck
dev 3000 schreiben
preview 4173 prüfen

#Zitate

> Dokumentation ist ein Liebesbrief an dein zukünftiges Ich.

Dokumentation ist ein Liebesbrief an dein zukünftiges Ich.

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

#Trennlinien

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

---

Diese Themen haben eigene Seiten:

  • Links und Bilder: Links zwischen Seiten, Bilder und Downloads.
  • Codeblöcke: Syntaxhervorhebung, hervorgehobene Zeilen und Diffs.
  • Hinweise: Notizen, Tipps und Warnungen.
  • HTML: HTML in Markdown und was Clay daraus entfernt.