Theme-Optionen¶

Alle Optionen stehen unter theme: in der mkdocs.yml. Wo die mitgelieferten Themes mkdocs und readthedocs bereits eine Option kennen, trägt sie hier denselben Namen und dieselbe Bedeutung.

Kompatibel zu den mitgelieferten Themes¶

Option	Typ	Vorgabe	Bedeutung
`highlightjs`	Wahrheitswert	`true`	Syntaxhervorhebung mit highlight.js (lokal, kein CDN)
`hljs_languages`	Liste	`[]`	Zusätzliche Sprachen, z. B. `[rust, php]`
`hljs_style`	Text	`github`	Farbschema hell, Dateiname aus `vendor/highlightjs/styles`
`hljs_style_dark`	Text	`github-dark`	Farbschema dunkel
`analytics.gtag`	Text	`null`	Google-Analytics-Kennung; nur nach eigener Prüfung setzen
`analytics.anonymize_ip`	Wahrheitswert	`false`	IP-Anonymisierung an gtag durchreichen
`include_homepage_in_sidebar`	Wahrheitswert	`true`	Startseite in der Seitenleiste zeigen
`prev_next_buttons_location`	Text	`bottom`	`top`, `bottom`, `both` oder `none`
`navigation_depth`	Zahl	`4`	Tiefe des Navigationsbaums
`titles_only`	Wahrheitswert	`true`	`false` zeigt die Gliederung der aktiven Seite in der Seitenleiste
`sticky_navigation`	Wahrheitswert	`true`	Seitenleiste und Gliederung laufen mit
`collapse_navigation`	Wahrheitswert	`true`	Nur der aktive Abschnitt ist aufgeklappt
`logo`	Pfad	`null`	Logo, relativ zu `docs_dir`
`color_mode`	Text	`auto`	`auto`, `light` oder `dark`
`user_color_mode_toggle`	Wahrheitswert	`true`	Umschalter in der Kopfzeile
`include_search_page`	Wahrheitswert	`true`	Eigenständige Seite `search.html` erzeugen
`search_index_only`	Wahrheitswert	`false`	Nur den Suchindex schreiben, keine Such-Oberfläche
`locale`	Text	`de`	Sprache der Seite und Stemming der Suche

Nicht übernommen wurden nav_style und shortcuts aus dem mkdocs-Theme: KERN kennt keine Navbar-Varianten, und Tastaturkürzel ohne sichtbare Erklärung schaffen mehr Verwirrung als Nutzen.

Eigene Optionen¶

Option	Typ	Vorgabe	Bedeutung
`show_toc`	Wahrheitswert	`true`	Gliederungsspalte rechts
`toc_depth`	Zahl	`3`	Tiefste Überschriftenebene in der Gliederung
`toc_scrollspy`	Wahrheitswert	`true`	Sichtbaren Abschnitt in der Gliederung markieren
`show_breadcrumb`	Wahrheitswert	`true`	Brotkrumenpfad über dem Inhalt
`show_edit_link`	Wahrheitswert	`true`	„Diese Seite bearbeiten“ (braucht `repo_url` + `edit_uri`)
`show_search`	Wahrheitswert	`true`	Suchknopf in der Kopfzeile
`copy_code`	Wahrheitswert	`true`	Kopierknopf an Codeblöcken
`admonition_icons`	Wahrheitswert	`true`	KERN-Symbole in Hinweisen
`content_width`	Länge	`50rem`	Lesebreite des Fließtexts
`max_width`	Länge	`90rem`	Gesamtbreite der Seite
`logo_alt`	Text	`''`	Alternativtext des Logos; leer = dekorativ
`favicon`	Pfad	`null`	Favicon, relativ zu `docs_dir`
`homepage_title`	Text	`null`	Beschriftung der Startseite im Brotkrumenpfad
`footer_text`	Text	`''`	Freier Text in der Fußzeile
`footer_links`	Liste	`[]`	Einträge `{text, href, external}`; siehe unten
`show_kern_credit`	Wahrheitswert	`true`	Hinweis auf KERN und die Kit-Version

Fußzeilen-Links¶

href darf auf die Markdown-Quelldatei zeigen – das Theme schlägt sie in der Dateiliste nach und setzt die gebaute Adresse ein, relativ zur aktuellen Seite:

theme:
  footer_links:
    - text: Impressum
      href: impressum.md
    - text: Barrierefreiheit
      href: referenz/barrierefreiheit.md
    - text: KERN Design-System
      href: https://www.kern-ux.de
      external: true

Wird der Pfad nicht gefunden, bleibt er unverändert – so lassen sich auch fertige Adressen (impressum/) eintragen. external: true markiert den Link mit Symbol und Hinweis für Screenreader.

Texte¶

Jeder sichtbare Text ist überschreibbar. Die Schlüssel beginnen mit lang_:

theme:
  name: kern-ux
  lang_search: Volltextsuche
  lang_edit: Seite im Repository bearbeiten

Schlüssel	Vorgabe
`lang_skip_to_content`	Zum Inhalt springen
`lang_nav_label`	Dokumentation
`lang_nav_toggle`	Menü
`lang_toc_label`	Auf dieser Seite
`lang_breadcrumb_label`	Sie sind hier
`lang_home`	Startseite
`lang_previous`	Zurück
`lang_next`	Weiter
`lang_search`	Suche
`lang_search_placeholder`	Suchbegriff eingeben
`lang_search_submit`	Suchen
`lang_search_close`	Schließen
`lang_search_results`	Suchergebnisse
`lang_search_no_results`	Keine Treffer gefunden.
`lang_search_hint`	Der Suchindex wird geladen …
`lang_edit`	Diese Seite bearbeiten
`lang_copy`	Code kopieren
`lang_copied`	Kopiert
`lang_code_region`	Codeblock, horizontal scrollbar
`lang_theme_dark`	Dunkles Design
`lang_theme_light`	Helles Design
`lang_external`	Öffnet eine externe Seite
`lang_404_title`	Seite nicht gefunden
`lang_404_text`	Die aufgerufene Seite existiert nicht oder wurde verschoben.
`lang_404_home`	Zur Startseite