Jamdesk Documentation logo

Überschriften

Strukturieren Sie Seiten mit H2- und H3-Überschriften, die das Inhaltsverzeichnis rechts automatisch füllen und teilbare Anchor-Links erzeugen.

Markdown-Überschriften (##, ###) unterteilen Ihre Seite in Abschnitte, die Leser schnell überblicken können. Jamdesk erkennt H2- und H3-Überschriften für das Inhaltsverzeichnis auf der rechten Seite und erstellt Anchor-Links, die Sie direkt teilen können.

Grundlegende Verwendung

Verwenden Sie Standard-Markdown-Überschriften, um Ihre Inhalte zu strukturieren:

## Section Title

Content goes here...

### Subsection

More detailed content...

H2- und H3-Überschriften erscheinen im Table of Contents auf der rechten Seite, sodass Leser zwischen Abschnitten langer Seiten wechseln können.

Jede Überschrift erzeugt automatisch eine Anker-ID aus ihrem Text:

ÜberschriftGenerierter Anker
## Getting Started#getting-started
## API Reference#api-reference
### User Authentication#user-authentication

Bewegen Sie den Mauszeiger über eine H2- oder H3-Überschrift, um ein Link-Symbol anzuzeigen. So können Sie Direktlinks zu bestimmten Abschnitten einfach teilen:

  • Klicken Sie auf das Link-Symbol, um die URL in Ihre Zwischenablage zu kopieren.
  • Klicken Sie auf den Überschriftentext, um die URL zu kopieren und zu diesem Abschnitt zu navigieren.

Das Link-Symbol erscheint in einem kleinen umrandeten Feld links neben der Überschrift. Wenn Sie einen Link kopieren, ändert das Symbol kurz seine Farbe, um die Aktion zu bestätigen.

Auf Mobilgeräten ist das Link-Symbol ausgeblendet, da es keinen Hover-Status gibt. Überschriften funktionieren weiterhin normal für die Navigation.

Auf Überschriften verlinken

Verweisen Sie von anderen Seiten mithilfe des Ankers auf bestimmte Abschnitte:

See the [headings section](/content/mdx-basics#headings) for details.

Best Practices

Beginnen Sie mit H2 für Hauptabschnitte und H3 für Unterabschnitte:

## Installation

### Prerequisites

### Quick Install

## Configuration

### Basic Options

### Advanced Options

Vermeiden Sie das Überspringen von Ebenen, z. B. einen Sprung von H2 zu H4.

Kurze Überschriften lassen sich leichter überblicken:

{/* Good */}
## Authentication

{/* Avoid */}
## How to Set Up Authentication in Your Application

Schreiben Sie nur das erste Wort und Eigennamen groß:

{/* Good */}
## Getting started with the API

{/* Avoid */}
## Getting Started With The API

Wie geht es weiter?

SEO-Optimierung

Auffindbarkeit und Metadaten verbessern

Frontmatter

Titel, Beschreibungen und SEO-Felder definieren