Überschriften und Text

Erfahren Sie, wie Sie Text formatieren, Überschriften erstellen und Inhalte gestalten.

Überschriften

Überschriften strukturieren Ihre Inhalte und erzeugen Navigationsanker. Sie erscheinen im Inhaltsverzeichnis und helfen Nutzerinnen und Nutzern, Ihre Dokumentation schnell zu erfassen.

Überschriften erstellen

Verwenden Sie #-Symbole, um Überschriften unterschiedlicher Ebenen zu erstellen:

## Hauptabschnitt
### Unterabschnitt
#### Unter-Unterabschnitt

Verwenden Sie aussagekräftige, keyword-reiche Überschriften, die den nachfolgenden Inhalt klar erkennen lassen. Das verbessert sowohl die Navigation für Nutzer als auch die Suchmaschinenoptimierung.

Ankerlinks deaktivieren

Standardmäßig enthalten Überschriften anklickbare Ankerlinks, mit denen Nutzerinnen und Nutzer direkt zu bestimmten Abschnitten verlinken können. Sie können diese Ankerlinks mit dem noAnchor-Prop in HTML- oder React-Überschriften deaktivieren.

HTML header example

<h2 noAnchor>
Überschrift ohne Ankerlink
</h2>

Wenn noAnchor verwendet wird, zeigt die Überschrift das Anker-Icon nicht an, und ein Klick auf den Überschriftstext kopiert den Ankerlink nicht in die Zwischenablage.

Textformatierung

Wir unterstützen die meisten Markdown-Formatierungen zum Hervorheben und Gestalten von Text.

Grundlegende Formatierung

Wende diese Formatierungsstile auf deinen Text an:

Stil	Syntax	Beispiel	Ergebnis
Fett	**text**	**wichtiger Hinweis**	wichtiger Hinweis
Kursiv	_text_	_Hervorhebung_	Hervorhebung
Durchgestrichen	~text~	~veraltete Funktion~	veraltete Funktion

Formatierungen kombinieren

Sie können Formatierungsstile kombinieren:

**_bold and italic_**
**~~bold and strikethrough~~**
*~~italic and strikethrough~~**

fett und kursiv
fett und durchgestrichen
kursiv und durchgestrichen

Hoch- und Tiefstellung

Für mathematische Ausdrücke oder Fußnoten verwenden Sie HTML-Tags:

Typ	Syntax	Beispiel	Ergebnis
Hochstellung	<sup>text</sup>	example<sup>2</sup>	example2
Tiefstellung	<sub>text</sub>	example<sub>n</sub>	examplen

Links

Links helfen Benutzer:innen, zwischen Seiten zu navigieren und auf externe Ressourcen zuzugreifen. Verwenden Sie aussagekräftige Linktexte, um die Barrierefreiheit und das Nutzererlebnis zu verbessern.

Interne Links

Verlinke auf andere Seiten in deiner Dokumentation mit pfadbezogenen Links ab Root:

[Quickstart](/quickstart)
[Steps](/components/steps)

Quickstart
Steps

Vermeide relative Links wie [page](../page), da sie langsamer laden und nicht so effektiv optimiert werden können wie root-relative Links.

Externe Links

Für externe Ressourcen die vollständige URL angeben:

[Markdown Guide](https://www.markdownguide.org/)

Markdown Guide

Defekte Links

Sie können in Ihrer Dokumentation mithilfe der CLI nach defekten Links suchen:

mint broken-links

Blockzitate

Blockzitate heben wichtige Informationen, Zitate oder Beispiele in deinen Inhalten hervor.

Einzeilige Blockzitate

Füge > vor den Text, um ein Blockzitat zu erstellen:

> This is a quote that stands out from the main content.

Dies ist ein Zitat, das sich vom Hauptinhalt abhebt.

Mehrzeilige Blockzitate

Für längere Zitate oder mehrere Absätze:

> Dies ist der erste Absatz eines mehrzeiligen Blockzitats.
>
> Dies ist der zweite Absatz, getrennt durch eine leere Zeile mit `>`.

Dies ist der erste Absatz eines mehrzeiligen Blockzitats.

Dies ist der zweite Absatz, getrennt durch eine leere Zeile mit >.

Verwenden Sie Blockzitate sparsam, um ihre visuelle Wirkung und Aussagekraft zu erhalten. Ziehen Sie für Hinweise, Warnungen und andere Informationen Callouts in Betracht.

Mathematische Ausdrücke

Wir unterstützen LaTeX zur Darstellung mathematischer Ausdrücke und Gleichungen.

Inline-Mathematik

Verwenden Sie einzelne Dollarzeichen, $, für mathematische Ausdrücke im Fließtext:

The Pythagorean theorem states that $(a^2 + b^2 = c^2)$ in a right triangle.

Der Satz des Pythagoras besagt, dass $(a^2 + b^2 = c^2)$ in einem rechtwinkligen Dreieck gilt.

Blockgleichungen

Verwenden Sie doppelte Dollarzeichen ($$) für eigenständige Gleichungen:

$$
E = mc^2
$$

$$E = mc^2$$

Die LaTeX-Unterstützung erfordert korrekte mathematische Syntax. Ausführliche Syntaxrichtlinien finden Sie in der LaTeX-Dokumentation.

Zeilenumbrüche und Abstände

Steuern Sie Abstände und Zeilenumbrüche, um die Lesbarkeit der Inhalte zu verbessern.

Absatzumbrüche

Trennen Sie Absätze durch Leerzeilen:

This is the first paragraph.

This is the second paragraph, separated by a blank line.

Dies ist der erste Absatz.

Dies ist der zweite Absatz, getrennt durch eine Leerzeile.

Manuelle Zeilenumbrüche

Verwenden Sie HTML-<br />-Tags, um innerhalb von Absätzen erzwungene Zeilenumbrüche einzufügen:

This line ends here.<br />
This line starts on a new line.

Diese Zeile endet hier.
Diese Zeile beginnt in einer neuen Zeile.

In den meisten Fällen sind Absatzumbrüche mit Leerzeilen leserlicher als manuelle Zeilenumbrüche.

Best Practices

Inhaltsorganisation

• Verwenden Sie Überschriften, um eine klare Inhaltshierarchie zu erstellen
• Halten Sie die korrekte Hierarchie ein (nicht von H2 direkt zu H4 springen)
• Formulieren Sie Überschriften aussagekräftig und mit relevanten Schlüsselwörtern

Textformatierung

• Fett zur Betonung verwenden, nicht für ganze Absätze
• Kursiv für Begriffe, Titel oder subtile Hervorhebungen reservieren
• Übermäßige Formatierung vermeiden, die vom Inhalt ablenkt

Links

• Verwenden Sie aussagekräftigen Linktext statt „Hier klicken“ oder „Mehr erfahren“
• Nutzen Sie root-relative Pfade für interne Links
• Prüfen Sie Links regelmäßig, um defekte Verweise zu vermeiden