KERN-UX for MkDocs 0.2.0
MkDocs-Theme auf Basis des KERN-Designsystems der oeffentlichen Verwaltung.
Features
- Vollstaendiges KERN-Kit unveraendert gebuendelt
- Dokumentations-Navigation, Gliederungsspalte, Brotkrumenpfad, Zurueck/Weiter
- Hell-/Dunkel-Umschalter ueber die KERN-Farbtoken
- Volltextsuche als KERN-Dialog, ohne JavaScript ueber eine Suchseite nutzbar
- Syntaxhervorhebung mit lokal ausgeliefertem highlight.js, kein CDN
- Barrierefreiheit: Sprunglink, sichtbarer Fokus, Landmarken, Kontrastmodus
- Deutsche Oberflaeche, alle Texte ueber mkdocs.yml ueberschreibbar
- Optionsnamen der mitgelieferten Themes mkdocs und readthedocs werden unterstuetzt
Description
KERN-UX for MkDocs ist ein Theme fuer den statischen Dokumentations- generator MkDocs auf Basis des KERN Design-Systems (@kern-ux/native). KERN ist ein Open-Source-Designsystem der oeffentlichen Verwaltung, initiiert von den Laendern Hamburg und Schleswig-Holstein und laenderuebergreifend weiterentwickelt, mit dem Ziel eines barrierefrei zugaenglichen Staates.
Dieses Theme ist eine Nachnutzung durch eine Kommune, veroeffentlicht, damit andere Verwaltungen dieselbe Arbeit nicht erneut leisten muessen. Es handelt sich um ein nachgenutztes, nicht um ein offizielles Angebot des KERN-Projekts oder eines Landes.
Das komplette KERN-Kit wird unveraendert mitgeliefert; eine duenne Bridge uebersetzt das von MkDocs und Python-Markdown erzeugte Markup auf die KERN-Designtokens. Ein Update des Designsystems bleibt dadurch konfliktfrei. Es werden keine externen Dienste kontaktiert - Schriften, Stylesheets und JavaScript liegen im Paket.