Markdown Heading Syntax
Überschriften sind die wichtigsten Elemente zum Organisieren der Dokumentstruktur. Markdown unterstützt zwei Überschriften-Syntaxen: ATX-Stil und Setext-Stil.
ATX-Stil-Überschriften
Um eine Überschrift zu erstellen, fügen Sie ein Hash (#
) vor einem Wort oder einer Phrase hinzu. Die Anzahl der Hashes repräsentiert die Überschriftenstufe.
# Heading Level 1
## Heading Level 2
### Heading Level 3
#### Heading Level 4
##### Heading Level 5
###### Heading Level 6
Rendered Output
Heading Level 1
Heading Level 2
Heading Level 3
Heading Level 4
Heading Level 5
Heading Level 6
Optional Closing Syntax
Sie können ATX-Stil-Überschriften optional "schließen", was ausschließlich für die Ästhetik ist:
# Heading Level 1 #
## Heading Level 2 ##
### Heading Level 3 ###
Die Anzahl der #
am Ende muss nicht mit der Anfangsanzahl übereinstimmen; die Anzahl am Anfang bestimmt die Überschriftenstufe.
Setext-Stil-Überschriften
Sie können auch beliebig viele =
Zeichen unter Text für eine Level 1-Überschrift oder -
Zeichen für eine Level 2-Überschrift hinzufügen.
Heading Level 1
===============
Heading Level 2
---------------
Rendered Output
Heading Level 1
Heading Level 2
Überschriften-Best Practices
Kompatibilitätsüberlegungen
Wenn kein Leerzeichen zwischen dem Hash (#
) und dem Überschriftentext ist, können verschiedene Markdown-Anwendungen es anders behandeln. Für Kompatibilität fügen Sie ein Leerzeichen zwischen dem Hash und dem Überschriftentext hinzu.
✅ Empfohlen | ❌ Nicht empfohlen |
---|---|
# Dies ist eine Überschrift | #Dies ist eine Überschrift |
Verwendung von Leerzeilen
Für Kompatibilität fügen Sie Leerzeilen vor und nach den Überschriften hinzu.
Dies ist ein Absatz.
# Dies ist eine Überschrift
Dies ist ein anderer Absatz.
Überschriftenstufen
- Jedes Dokument sollte nur eine Level 1-Überschrift verwenden
- Halten Sie die Überschriftenstufen logisch; überspringen Sie keine Stufen
- Überschriften sollten die hierarchische Struktur des Dokuments widerspiegeln
Überschriftentext-Richtlinien
- Überschriftentext sollte kurz und klar sein
- Vermeiden Sie Satzzeichen (insbesondere Punkte)
- Verwenden Sie Verben oder substantivische Phrasen
- Halten Sie die Formatierung für Überschriften derselben Stufe konsistent
HTML-Ausgabe
Markdown-Überschriften werden in die entsprechenden HTML-Überschrift-Tags konvertiert:
# Heading → <h1>Heading</h1>
## Heading → <h2>Heading</h2>
### Heading → <h3>Heading</h3>
#### Heading → <h4>Heading</h4>
##### Heading → <h5>Heading</h5>
###### Heading → <h6>Heading</h6>
Überschriften-IDs (Erweiterte Funktion)
Viele Markdown-Verarbeiter generieren automatisch IDs für Überschriften, die zum Erstellen von Anker-Links verwendet werden können:
<h1 id="markdown-heading-syntax">Markdown Heading Syntax</h1>
Dies ermöglicht es Ihnen, auf eine bestimmte Überschrift zu verlinken:
[Link zur Überschrift](#markdown-heading-syntax)
Praktisches Beispiel
Unten ist ein Beispiel für ein Dokument mit einer gut strukturierten Überschriftenhierarchie:
# Benutzerhandbuch
## Schnellstart
### Installationsschritte
#### Systemanforderungen
#### Download und Installation
### Grundlegende Konfiguration
## Erweiterte Funktionen
### Benutzerdefinierte Einstellungen
### Plugin-Verwaltung
## Fehlerbehebung
### FAQ
### Kontakt zum Support
Eine solche klare Überschriftenstruktur macht das Dokument einfach zu lesen und zu navigieren.