Leichte Sprache Checker – Bedienungsanleitung

Benutzer-Dokumentation (MkDocs) für den Leichte Sprache Checker. Sie richtet sich an Anwender:innen, die Texte in Leichte Sprache übersetzen, prüfen oder verwalten möchten.

Voraussetzungen

• Python 3.11+
• pip oder uv

Installation

pip install -r requirements.txt

Lokale Entwicklung

# Lokaler Vorschau-Server mit Auto-Reload
mkdocs serve

# Im Browser öffnen
open http://127.0.0.1:8081

Statische Seite bauen

mkdocs build
# Ausgabe in docs/

Verzeichnisstruktur

leichte-sprache-docs-user/
├── mkdocs.yml              # MkDocs-Konfiguration
├── requirements.txt        # Python-Abhängigkeiten
├── README.md               # Diese Datei
│
├── src/                    # Quelldateien der Dokumentation
│   ├── index.md            # Startseite
│   ├── ueber/              # Was ist es / Zielgruppen / Funktionsweise
│   ├── erste-schritte/     # Einstieg
│   ├── anleitungen/        # Schritt-für-Schritt-Anleitungen
│   ├── funktionen/         # Features im Detail
│   ├── browser-extension/  # Chrome- und Firefox-Erweiterung
│   ├── barrierefreiheit/   # A11y-Hinweise
│   ├── faq.md              # Häufige Fragen
│   └── assets/             # Bilder und statische Dateien
│
└── docs/                   # Build-Ausgabe (nach `mkdocs build`)

Lizenz

Inhalte stehen unter CC BY-SA 4.0.