Frontmatter-Referenz

Jede Dokumentationsseite in diesem Theme verwendet Frontmatter, um Metadaten zu definieren und die Darstellung der Seite zu steuern. Hier findest du eine vollständige Referenz aller verfügbaren Frontmatter-Optionen.

Erforderliche Felder

---
title: "Seitentitel"
---

title

• Typ: string

Der Titel der Seite. Er erscheint oben auf der Seite und in der Navigation.

Optionale Felder

---
description: Eine kurze Beschreibung des Seiteninhalts
section: "advanced-features"
section: "docs-section"
sidebar:
  label: Eigenes Label
  order: 1
  badge:
    text: Aktualisiert
    variant: note
tableOfContents:
  minHeadingLevel: 2
  maxHeadingLevel: 3
pagefind: true
draft: true
---

description

• Typ: string

Eine kurze Beschreibung des Seiteninhalts. Sie wird für SEO-Zwecke verwendet und sollte knapp zusammenfassen, was Nutzer:innen auf der Seite erwartet.

section

• Typ: string

Der Abschnitt, zu dem die Seite gehört. Er wird genutzt, um Seiten in der Navigation zu gruppieren. Jede Gruppe hat einen Link am oberen Rand der Sidebar, über den Nutzer:innen zur ersten Seite dieses Abschnitts navigieren können. Jeder Abschnitt hat zur übersichtlichen Organisation eine eigene Sidebar.

Seiten ohne konfigurierten Abschnitt werden dem Abschnitt „main” zugeordnet.

sidebar

• Typ: object

Steuert, wie die Seite in der Sidebar-Navigation erscheint.

Eigenschaften:

• label (string, optional): Eigenes Label für die Sidebar. Wird nichts angegeben, wird der Seitentitel verwendet.
• order (number, optional): Bestimmt die Reihenfolge der Seiten innerhalb ihres Abschnitts. Niedrigere Zahlen erscheinen zuerst. Seiten ohne Order-Wert werden alphabetisch sortiert.
• badge (object, optional): Zeigt in der Sidebar ein Badge neben dem Seitentitel an.
  • text (string): Der angezeigte Badge-Text
  • variant ("note" | "tip" | "caution" | "danger" | "info"): Die Stilvariante des Badges

Beispiel mit Badge:

sidebar:
  label: "API-Leitfaden"
  order: 2
  badge:
    text: "Neu"
    variant: "info"

tableOfContents

• Typ: object
• Standard: { minHeadingLevel: 2, maxHeadingLevel: 3 }

Legt fest, welche Überschriften im Inhaltsverzeichnis erscheinen.

Eigenschaften:

• minHeadingLevel (number, optional): Die minimale Überschriftenebene (h1-h6). Standard ist 2.
• maxHeadingLevel (number, optional): Die maximale Überschriftenebene (h1-h6). Standard ist 3.

pagefind

• Typ: boolean
• Standard: true

Bestimmt, ob der Seiteninhalt von Pagefind für die Suchfunktion indexiert wird. Auf false setzen, um die Seite aus den Suchergebnissen auszuschließen.

draft

• Typ: boolean
• Standard: false

Wenn auf true gesetzt, wird die Seite in der Produktion nicht veröffentlicht. Das ist nützlich für in Arbeit befindliche Inhalte.

Beispielkonfiguration

---
title: Meine Dokumentationsseite
description: Ein umfassender Leitfaden zur Nutzung unserer Produkt-API
section: "advanced-features"
section: "api"
sidebar:
  label: API-Leitfaden
  order: 2
tableOfContents:
  minHeadingLevel: 2
  maxHeadingLevel: 4
pagefind: false
draft: false
---