Front-Matter-Referenz
Diese Referenz wird automatisch aus den Front-Matter-Typdefinitionen generiert.
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| title | string | false | Titel der Seite. Wird als Überschrift, im Browser-Tab und in der Navigation verwendet. |
| sidebarTitle | string | false | Überschreibt title speziell in der Seitenleiste und im Breadcrumb. |
| description | string | false | Kurzbeschreibung der Seite für die description-Meta-Angabe und Suchergebnisse. |
| lang | string | false | Sprache der Seite als Locale-Kennung (z. B. de), setzt html[lang] für diese Seite. |
| siteIndex | boolean | false | Leitet die Website-Wurzel (/) auf diese Seite um. Der CLI/Easy Mode generiert beim Build eine automatische Weiterleitung. Kein Effekt im Developer Mode. |
| folderIndex | boolean | false | Blendet index.mdx aus der Seitenleiste aus, während der Ordnertitel weiterhin als klickbarer Link zur Seite navigiert. Entspricht dem Verhalten des Geschwisterdatei-Musters (docs.mdx neben docs/). |
| seo | SeoConfig | false | SEO- und Social-Media-Metadaten der Seite. |
| seo.keyword_primary | string | false | Primäres Fokus-Keyword der Seite. |
| seo.keywords_secondary | string[] | false | Weitere unterstützende Keywords der Seite. |
| seo.canonical_url | string | false | Kanonische URL der Seite (<link rel="canonical">), um Duplicate Content zu vermeiden. |
| seo.hreflang | HreflangEntry[] | false | Sprachvarianten der Seite für hreflang-Verweise. |
| seo.hreflang[].lang | string | true | Sprach- bzw. Locale-Kennung dieser Sprachvariante (z. B. de, en, de-AT). |
| seo.hreflang[].url | string | true | Absolute URL der Seite in dieser Sprache. |
| seo.og | OgConfig | false | Open-Graph-Metadaten für Social-Media-Vorschauen. |
| seo.og.image | string | false | URL des Vorschaubilds für Social-Media-Vorschauen (og:image). |
| seo.og.image_alt | string | false | Alternativtext des Open-Graph-Vorschaubilds (og:image:alt). |
| seo.og.image_width | number | false | Breite des Vorschaubilds in Pixeln (og:image:width). |
| seo.og.image_height | number | false | Höhe des Vorschaubilds in Pixeln (og:image:height). |
| seo.og.type | "article" | "website" | false | Open-Graph-Typ der Seite (og:type). |
| seo.schema | SchemaConfig | false | Strukturierte Daten (schema.org / JSON-LD) für die Seite. |
| seo.schema.type | "Article" | "TechArticle" | "HowTo" | "FAQPage" | false | Typ des strukturierten Daten-Schemas (schema.org), das für die Seite erzeugt wird. |
| seo.schema.date_published | string | false | Veröffentlichungsdatum im ISO-8601-Format (z. B. 2026-06-30). |
| seo.schema.date_modified | string | false | Datum der letzten Änderung im ISO-8601-Format. |
| seo.robots | string | false | Wert des robots-Meta-Tags (z. B. index,follow oder noindex). |
| seo.site_name | string | false | Name der Website für Metadaten (og:site_name). |
| seo.ignore_checks | string[] | false | Namen von SEO-Prüfungen, die für diese Seite übersprungen werden sollen. |
| metaTitle | string | false | Veraltet: früherer Alias für title. Verwenden Sie stattdessen title. |
| metaDescription | string | false | Veraltet: früherer Alias für description. Verwenden Sie stattdessen description. |
| canonical | string | false | Veraltet: früherer Alias für seo.canonical_url. Verwenden Sie stattdessen seo.canonical_url. |
| image | string | false | Veraltet: früherer Alias für seo.og.image. Verwenden Sie stattdessen seo.og.image. |
| theme | Partial<PageTheme> | false | Seitenbezogene Darstellungsüberschreibungen (Layout, Breadcrumb, Footer, eigener Inhalt oben/unten), die auf diese Seite und ihre Unterseiten angewendet werden. Siehe die PageTheme-Referenz unten. |
| disableToc | boolean | false | Blendet das Inhaltsverzeichnis für diese Seite aus. |
PageTheme
Überschreibt die Darstellung einer Seite und aller darunterliegenden Seiten. Nicht gesetzte Felder behalten ihren Standardwert (layout: "default", breadcrumb: true, footer: true).
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| breadcrumb | boolean | false | Ob der Breadcrumb-Pfad oberhalb des Seiteninhalts angezeigt wird. Ohne Wirkung bei Einträgen vom Typ page oder wenn layout "raw"/"empty" ist. |
| footer | boolean | false | Ob der Website-Footer unterhalb des Seiteninhalts angezeigt wird. |
| layout | "default" | "full" | "raw" | "empty" | false | Steuert das gesamte Seitengerüst. "default": Seitenleiste, Breadcrumb, Inhaltsverzeichnis und die übliche Inhaltsspalte mit maximaler Breite. "full": Inhalt in voller Breite ohne Seitenleiste und Inhaltsverzeichnis (Breadcrumb weiterhin möglich). "raw": nur der Seiteninhalt samt globalem Header/Footer — keine Seitenleiste, kein Breadcrumb, kein Inhaltsverzeichnis und kein Innenabstand. "empty": ausschließlich der Seiteninhalt, ohne Header, Footer, Seitenleiste oder Provider. |
| topContent | ReactNode | FC | false | Eigener Inhalt, der oberhalb des Seiteninhalts angezeigt wird (ReactNode oder Komponente). |
| bottomContent | ReactNode | FC | false | Eigener Inhalt, der unterhalb des Seiteninhalts angezeigt wird (ReactNode oder Komponente). |