Frontmatter-Referenz

Frontmatter ermöglicht Konfigurationsüberschreibungen auf Seitenebene. Deklarieren Sie YAML-Metadaten ganz oben in Ihren Markdown-Dateien zwischen Dreifach-Bindestrich-Trennzeichen (---).

Kernmetadaten-Eigenschaften

Schlüssel Typ Beschreibung
title String Empfohlen. Setzt das HTML-<title>-Tag und den primären Seiten-Header.
description String Setzt die Meta-Beschreibung für SEO, Suchmaschinen, llms.txt und OKF-Manifeste.
keywords Array | String Suchschlüsselwörter für <meta name="keywords">, die auch als Tags für OKF-Bundles extrahiert werden.
tags Array | String Konzept-Tags für Open Knowledge Format (/okf/)-Manifeste und Wissensgraphen.
Best Practices für Metadaten

Die Bereitstellung eines expliziten title und einer description im Frontmatter stellt sicher, dass Suchmaschinen und KI-Kontextgeneratoren Ihre Dokumentation genau indizieren.

Steuerung von Indizierung & Sichtbarkeit

Schlüssel Typ Beschreibung
noindex Boolean Bei true wird die Seite aus Suchindizes, Sitemaps und KI-Bundles ausgeschlossen.
okf Boolean Auf false setzen, um das Dokument ausschließlich von OKF-Bundles (/okf/) auszuschließen.
llms Boolean Auf false setzen, um das Dokument aus kompilierten KI-Kontextdateien (llms.txt) auszuschließen.
type String Explizite Konzepttyp-Klassifizierung für OKF-Bundles (z. B. guide, api, concept).
hideTitle Boolean Bei true wird der Haupttitel im Seiten-Headerbereich ausgeblendet.
bodyClass String Fügt dem übergeordneten <body>-Element benutzerdefinierte CSS-Klassen hinzu.

Layout- & Viewport-Konfiguration

Schlüssel Typ Beschreibung
layout String Auf "full" setzen, um die Inhaltsbreite zu erweitern und das Inhaltsverzeichnis (TOC) zu deaktivieren.
toc Boolean Auf false setzen, um die rechtsseitige Inhaltsverzeichnis-Sidebar zu deaktivieren.
noStyle Boolean Deaktiviert standardmäßige UI-Elemente (Sidebar, Header, Footer) für benutzerdefinierte HTML-Seiten.
titleSeparator String Benutzerdefiniertes Trennzeichen für den Titel dieser Seite (z. B. "-", `"
titleAppend Boolean Auf false setzen, um zu verhindern, dass der globale Site-Titel an das HTML-<title> und Social Cards angehängt wird.

Feingranulare Komponentiensteuerung (noStyle)

Wenn noStyle: true aktiv ist, geben Sie einzelne zu erhaltende UI-Komponenten an:

---
noStyle: true
components:
  meta: true      # Injiziert SEO-Metadaten
  favicon: true   # Injiziert Site-Favicon
  css: true       # Injiziert docmd-main.css
  theme: true     # Injiziert themenspezifisches Styling
  highlight: true # Injiziert Syntaxhervorhebung
  scripts: true   # Injiziert die SPA-Router-Logik
  sidebar: true   # Injiziert die Navigations-Sidebar
  footer: true    # Injiziert den Site-Footer
---

Plugin- & SEO-Überschreibungen

Schlüssel Typ Beschreibung
image String URL für Vorschaukarten beim Teilen in sozialen Netzwerken (og:image).
aiBots Boolean Auf false setzen, um zu verhindern, dass KI-Crawler die Seite auslesen.
canonicalUrl String | Boolean Benutzerdefinierte kanonische URL für die SEO-Indizierung oder false, um das kanonische Tag zu unterdrücken.
ldJson Object | Array Benutzerdefinierte Schema.org JSON-LD strukturierte Daten, injiziert in den Seiten-<head>.
seo Object Verschachtelte SEO-Überschreibungen (titleSeparator, titleAppend, breadcrumbs, ldJson usw.).
Vorherige Weiterleitungen Nächste Syntax