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
**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
Erste Zeile
zweite Zeile, im selben Absatz
Ein neuer AbsatzTipp
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
- Installieren
- Konfigurieren
- Bauen
- Kaffee
- Tee
- Grüner Tee
- Schwarzer Tee
1. Installieren
2. Konfigurieren
3. BauenFür Anleitungen in einer Reihenfolge zeigen Schritte eine nummerierte Liste als Anleitung.
#Aufgabenlisten
- [x] Dokumentation schreiben
- [x] Seite bauen
- [ ] VeröffentlichenDie Kästchen lassen sich nicht ändern: Sie zeigen, was im Markdown steht, und Leser können sie nicht abhaken.
#Tabellen
Spalten lassen sich mit Doppelpunkten in der Trennzeile links, mittig oder rechts ausrichten:
| 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] oder ähnlichem beginnt, wird zu einem Hinweis.
#Waagerechte Linien
Drei Bindestriche in einer eigenen Zeile ziehen eine Linie über die Seite:
---#Typografie Neu in Clay 5
Clay setzt den Text deiner Seiten, wie es ein Setzer tun würde: Du schreibst ihn auf der Tastatur, und Leser sehen die richtigen Zeichen.
| Du schreibst | Leser sehen |
|---|---|
-> <- <-> => <=> |
→ ← ↔ ⇒ ⇔ |
<= >= != |
≤ ≥ ≠ |
1--2, a -- b, a --- b |
1–2, a – b, a — b |
... |
… |
(c) (r) (tm) +- |
© ® ™ ± |
"Anführungszeichen", 'einfache', geht's |
„Anführungszeichen“, ‚einfache‘, geht’s |
Anführungszeichen folgen der Sprache der Seite: Englische Seiten bekommen “quotes”, französische «guillemets». Für andere setze quotes in messages, z. B. quotes: "»«›‹": die öffnenden und schließenden doppelten, dann die einfachen.
Nur Text ändert sich. Code, Links, die ihre Adresse zeigen, HTML-Attribute, Mathematik, Prompts und die IDs von Überschriften bleiben, wie sie sind, so funktionieren Links zu Abschnitten weiter. Optionen wie --strict bleiben auch. Um ein einzelnes Zeichen zu behalten, setz einen Backslash davor: \-> zeigt ->.