Installation

Paket installieren

pip install mkdocs-kern-ux

Für das empfohlene Profil zusätzlich:

pip install "mkdocs-kern-ux[recommended]"

Theme aktivieren

theme:
  name: kern-ux

Das war alles – der KERN-Kit und highlight.js liegen im Paket und werden beim Bauen mit in die Site kopiert. Es wird kein CDN kontaktiert.

Aus dem Quellverzeichnis

git clone https://gitlab.opencode.de/sgemlichheim/kern-ux-theme-for-mkdocs.git
cd kern-ux-theme-for-mkdocs
npm install && npm run vendor:sync
pip install -e .
mkdocs serve -f demo/mkdocs.yml

Ohne Vendor-Ordner kein Design

npm run vendor:sync kopiert den KERN-Kit und highlight.js in das Theme. Im Git-Repository sind beide bereits eingecheckt; der Befehl ist nur nötig, wenn eine neue Version übernommen werden soll.

Diese Seite bearbeiten