Ausführen von mkdocs
Option 1: Lokal mit uv (empfohlen für Development)
Voraussetzung: uv ist installiert.
Installation von uv
# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
# Mit pip
pip install uv
Projekt starten
# Repo klonen
git clone https://gitea.rwcloud.ch/rewa81/mkdocs-wiki.git
cd mkdocs-wiki
# Dependencies installieren und MkDocs starten
uv run mkdocs serve
# Alternative: Erst sync, dann starten
uv sync
uv run mkdocs serve
Die Seite ist dann unter http://localhost:8000 erreichbar.
HTML Seiten lokal erstellen
uv run mkdocs build
Die statischen HTML-Dateien werden im Ordner site/ erstellt.
Option 2: Mit DevContainer in VSCode
Voraussetzung: VS-Code mit der Devcontainer Extension ist installiert, Docker Desktop ist installiert und läuft.
- Repo klonen
- In VSCode mit SHIFT+CMD+P die Funktion "Ordner in Container öffnen" klicken. Danach wird der DEV-Container gebuildet und gestartet.
- Aufruf der Seite mit http://localhost:8000
Option 3: Mit Docker-Compose File starten
Voraussetzung: Docker Desktop resp. Docker ist installiert und läuft.
- Repo klonen
- Im Terminal in das Root vom Repo gehen.
- Den Container starten mit
docker compose up -d - Aufruf der Seite mit http://localhost:8000
Konfiguriation
Die Konfiguration befindet sich in der Datei mkdocs.yml und befindet sich im Root des Repos.
Inhalt der Seite
Der gesamte Inhalt inkl. Multimedia und Scripts befindet sich im Ordner "docs".