Überzeugende Titel schreiben

Ihr Titel erscheint in: Browser-Tabs Suchmaschinenergebnissen Seitennavigation Social-Media-Beiträgen Halten Sie Titel unter 60 Zeichen. Platzieren Sie wichtige Suchbegriffe am Anfang.

Nützliche Beschreibungen erstellen

Beschreibungen erscheinen in Suchergebnissen und Social-Media-Vorschauen. Streben Sie 50–160 Zeichen an, die: den Seiteninhalt zusammenfassen relevante Suchbegriffe enthalten Nutzer zum Klicken anregen

Einheitliche Icons verwenden

Icons helfen Nutzern, die Navigation schnell zu erfassen. Verwenden Sie für verwandte Seiten dasselbe Icon: | Thema | Empfohlenes Icon | |-------|----------------| | Getting started | rocket | | Authentication | lock | | API reference | code | | Settings | gear | | Billing | credit-card | Durchsuchen Sie die Icons bei Font Awesome.

Ungültige YAML-Syntax

Behebung: Prüfen Sie Folgendes: Fehlende Anführungszeichen um Zeichenfolgen mit Sonderzeichen Falsche Einrückung Fehlende Doppelpunkte nach Schlüsseln Fügen Sie den Block zwischen den ----Markierungen in den kostenlosen YAML Validator ein, um die Zeile und Spalte des Fehlers zu ermitteln.

Frontmatter

Q: Erforderliche Felder fehlen

Behebung: Fügen Sie das Feld title zu Ihrem Frontmatter hinzu.

Jede MDX-Datei beginnt mit einem YAML-Block zwischen ----Markierungen. Diese Metadaten steuern den Seitentitel, das Erscheinungsbild der Seitenleiste und die Darstellung der Seite beim Teilen in sozialen Medien oder in Suchergebnissen.

Einfaches Frontmatter

Jede Seite benötigt mindestens einen Titel:

---
title: Getting Started
description: Learn the basics in 5 minutes
---

Verfügbare Felder

Erforderlich

Feld	Typ	Beschreibung
`title`	string	Seitentitel, der in der Navigation und im Browser-Tab angezeigt wird

Empfohlen

Feld	Typ	Beschreibung
`description`	string	Kurze Zusammenfassung für SEO und Suchergebnisse (50–160 Zeichen)

Optional

Feld	Typ	Standardwert	Beschreibung
`icon`	string	-	Font Awesome-Icon, das neben dem Seitentitel in der Seitenleistennavigation angezeigt wird
`sidebarTitle`	string	`title`	Kürzerer Titel für die Seitenleistennavigation
`mode`	string	-	Auf `"wide"` setzen, um ein Layout mit voller Breite zu verwenden
`hideFooter`	boolean	`false`	Sozialen Footer auf dieser Seite ausblenden
`rss`	boolean	`false`	RSS-Feed-Generierung aus Update-Komponenten auf dieser Seite aktivieren
`search`	boolean	`true`	Auf `false` setzen, um die Seite aus der Seitensuche, Antworten des KI-Chats und MCP auszuschließen. Sie bleibt in der Seitenleiste, der Sitemap und der llms.txt. Siehe Nur eine Seite aus der Suche ausschließen
`private`	boolean	`false`	Das Seitenpasswort zum Anzeigen dieser Seite voraussetzen. Wenn dies auf einer beliebigen Seite gesetzt wird, wird beim nächsten Build der Modus für bestimmte Seiten aktiviert.
`public`	boolean	`false`	Diese Seite vom Passwortschutz oder der JWT-Authentifizierung ausnehmen, wenn die gesamte Website geschützt ist. Hat Vorrang vor `private: true`, wenn beide gesetzt sind.
`groups`	string[]	-	Bei aktivierter JWT-Authentifizierung können nur Besucher, deren Token mindestens eine dieser Gruppen enthält, die Seite öffnen. Alle anderen erhalten einen 404-Fehler und sehen die Seite nicht in der Navigation. Bis zu 32 Gruppen pro Seite. Im Passwortmodus ignoriert. Siehe Gruppenbasierter Zugriff.
`lastUpdatedDate`	string	-	Überschreibt das „Last updated on“-Datum dieser Seite, statt das Datum ihres letzten Git-Commits zu verwenden. Setzen Sie den Wert in Anführungszeichen: `"2026-09-01"`. Die Fußzeile benötigt `metadata.timestamp` in `docs.json`; Ihre Sitemap und Ihre strukturierten Daten verwenden das Datum ohnehin. Siehe Datum der letzten Aktualisierung

Datum der letzten Aktualisierung

Mit aktiviertem metadata.timestamp in docs.json zeigt jede Seite das Datum des letzten Commits an, der ihre Datei geändert hat. lastUpdatedDate ersetzt dieses Datum auf einer einzelnen Seite:

---
title: Authentication
lastUpdatedDate: "2026-09-01"
---

Verwenden Sie es, wenn Sie eine Seite geprüft haben und das auch zeigen möchten, oder wenn ein reiner Formatierungs-Commit das Datum verschoben hat, ohne dass sich für Leser etwas geändert hätte.

Setzen Sie den Wert in Anführungszeichen. Ein 2026-09-01 ohne Anführungszeichen wird als Zeitstempel statt als Datum gelesen und kann um einen Tag abweichen. Ein Wert, der kein Datum ist, wird ignoriert und stattdessen erscheint das Commit-Datum – ein Tippfehler lässt die Zeile also nie leer.

Die Zeile in der Fußzeile erscheint nur bei aktiviertem metadata.timestamp, aber lastUpdatedDate ist nicht nur eine Fußzeilen-Einstellung: Das <lastmod> Ihrer Sitemap und das dateModified der strukturierten Daten der Seite verwenden es, ob die Fußzeile eingeschaltet ist oder nicht. Setzen Sie es, wenn das Datum gemeint ist, und nicht nur dann, wenn Sie es anzeigen möchten.

Die Überschreibung setzt auch dateModified in den strukturierten Daten der Seite, sodass Suchmaschinen und KI-Assistenten dasselbe Datum sehen wie Ihre Leser.

Steuern Sie, wie die Seite in Suchergebnissen und Social-Media-Vorschauen erscheint. Legen Sie diese Werte als flache Schlüssel der obersten Ebene oder in einem verschachtelten seo:-Block fest. Beides funktioniert, und seitenbezogene Werte überschreiben die docs.json-Standardwerte für seo.metatags.

Feld	Typ	Standardwert	Beschreibung
`keywords`	string[]	-	Suchbegriffe, die als `<meta name="keywords">`-Tag ausgegeben werden
`canonical`	string	auto	Kanonische URL für diese Seite, die die automatisch generierte URL überschreibt
`noindex`	boolean	`false`	Diese Seite aus Suchmaschinen und der Sitemap ausschließen
`og:` / `twitter:`	string	-	Open-Graph- und Twitter/X-Tags für Social-Media-Vorschauen (z. B. `og:title`, `og:image`, `twitter:card`)
`seo`	object	-	Verschachtelter Block für alle oben genannten sowie beliebige benutzerdefinierte Meta-Tags

---
title: API Reference
description: REST endpoints and authentication
"og:image": /images/api-card.png
"twitter:card": summary_large_image
canonical: https://docs.acme.com/api-reference
---

Siehe SEO-Optimierung für die vollständige Liste der unterstützten Tags und Beispiele.

Fügen Sie nach einem Build die Seiten-URL in das kostenlose Tool OpenGraph Preview ein, um zu sehen, wie diese Tags auf X, Facebook, LinkedIn, Slack, Discord und weiteren Plattformen dargestellt werden.

Beispiele

Standard-Dokumentationsseite

---
title: Authentication
description: Secure your API with OAuth 2.0 and API keys
icon: lock
---

Langer Titel mit Überschreibung der Seitenleiste

---
title: Configuring Single Sign-On with SAML 2.0
sidebarTitle: SSO Setup
description: Set up enterprise SSO for your organization
---

Der vollständige Titel wird auf der Seite angezeigt, während sidebarTitle die Navigation übersichtlich hält.

Layout mit voller Breite

---
title: API Reference
description: Complete API documentation
mode: wide
---

Der breite Modus entfernt das Inhaltsverzeichnis und erweitert den Inhalt auf die volle Breite. Das ist nützlich für API-Referenzseiten oder Inhalte mit breiten Tabellen.

Footer ausblenden

---
title: Custom Landing
description: A focused landing page experience
hideFooter: true
---

Verwenden Sie hideFooter für Landingpages, Changelog-Seiten oder jede Seite, auf der Sie einen übersichtlicheren unteren Bereich ohne Social-Media-Links wünschen.

SEO-Best Practices

Ihr Titel erscheint in:

Browser-Tabs
Suchmaschinenergebnissen
Seitennavigation
Social-Media-Beiträgen

Halten Sie Titel unter 60 Zeichen. Platzieren Sie wichtige Suchbegriffe am Anfang.

# Good - clear and keyword-rich
title: Deploy to Production

# Avoid - vague or too long
title: How to Deploy Your Application to Production Servers

Beschreibungen erscheinen in Suchergebnissen und Social-Media-Vorschauen. Streben Sie 50–160 Zeichen an, die:

den Seiteninhalt zusammenfassen
relevante Suchbegriffe enthalten
Nutzer zum Klicken anregen

# Good - actionable and specific
description: Deploy your docs to production in under 2 minutes with zero configuration

# Avoid - generic or missing
description: Documentation page

Icons helfen Nutzern, die Navigation schnell zu erfassen. Verwenden Sie für verwandte Seiten dasselbe Icon:

Thema	Empfohlenes Icon
Getting started	`rocket`
Authentication	`lock`
API reference	`code`
Settings	`gear`
Billing	`credit-card`

Durchsuchen Sie die Icons bei Font Awesome.

Validierung

Jamdesk validiert das Frontmatter beim Build. Häufige Fehler:

Error: Page "api/auth.mdx" is missing required field: title

Behebung: Fügen Sie das Feld title zu Ihrem Frontmatter hinzu.

Error: Invalid frontmatter in "guide.mdx": unexpected token

Behebung: Prüfen Sie Folgendes:

Fehlende Anführungszeichen um Zeichenfolgen mit Sonderzeichen
Falsche Einrückung
Fehlende Doppelpunkte nach Schlüsseln

Fügen Sie den Block zwischen den ----Markierungen in den kostenlosen YAML Validator ein, um die Zeile und Spalte des Fehlers zu ermitteln.

Wie geht es weiter?

SEO-Optimierung

Optimieren Sie Ihre Dokumentation für Suchmaschinen

MDX-Grundlagen

Lernen Sie die Grundlagen von MDX kennen