KERN-UX für MkDocs¶

Ein MkDocs-Theme auf Basis des KERN Design-Systems – dem offenen Design-System für die öffentliche Verwaltung, initiiert von Hamburg und Schleswig-Holstein.

Der komplette KERN-Kit liegt unverändert im Theme; alles, was das Theme selbst mitbringt, ist eine dünne Bridge: Templates, ein Stylesheet ohne eigene Designwerte und etwas Vanilla-JavaScript.

Diese Seite ist die Demo

Sie führt jeden Baustein vor, den das Theme abbildet – von der Typografie über Hinweise und Tabellen bis zu den KERN-Komponenten in rohem HTML.

Was das Theme mitbringt¶

Navigationsbaum, Gliederungsspalte, Brotkrumenpfad, Zurück/Weiter
Hell/Dunkel-Umschalter über die KERN-Token, ohne Aufblitzen beim Laden
Suche als KERN-Dialog auf Basis des mitgelieferten Such-Plugins
Syntaxhervorhebung mit highlight.js – lokal ausgeliefert, kein CDN
Deutsche Oberfläche, jeder Text über mkdocs.yml überschreibbar

Schnellstart¶

pip install mkdocs-kern-ux

theme:
  name: kern-ux

Weiter geht es bei Installation.