docs.freya-tde.dev

Die Dokumentation des Projekts Freya TDE – je Sprache ein mdBook (≥ 0.5): Deutsch unter /de/, Englisch unter /en/, eine Sprachwahl unter /. Der Inhalt liegt nicht hier, sondern in den Repositorys der Programme und wird beim Bauen eingesammelt:

The documentation of the Freya TDE project – one mdBook per language. The content lives in the program repositories and is collected at build time:

Teil / part Quelle / source
Freya TDE – Handbuch Freya-TDE/Freya-TDE docs/de, docs/en
RUF & RNCL Freya-TDE/RUF docs/de, docs/en
CT-Editor Freya-TDE/CT-E docs/de, docs/en

Bauen / build

# Repositorys nach sources/ klonen – oder auf vorhandene Ordner zeigen:
FREYA_TDE_SRC=~/…/Freya-TDE RUF_SRC=~/…/RUF CTE_SRC=~/…/CT-E python3 tools/build.py
python3 -m http.server -d public 8000      # Vorschau: http://127.0.0.1:8000
python3 tools/build.py --serve de          # ein Buch mit Live-Neuladen (mdbook serve)

tools/build.py (nur Python-Standardbibliothek):

site/ enthält Buch-Einstellungen (book.toml), Farben (freya.css, #990000 = Hausfarbe, hell / dunkel / System), den Sprachumschalter (freya.js), die Einführungsseiten und die Sprachwahl (index.html).

Veröffentlichen / publish

Der Workflow .github/workflows/pages.yml baut bei jedem Push, von Hand und auf ein repository_dispatch vom Typ docs aus einem Programm-Repo. Voraussetzung: öffentliches Repository, Settings → Pages → Source: GitHub Actions, Domain docs.freya-tde.dev (Datei site/CNAME).

Lizenz / license: MIT OR Apache-2.0, © Dragon Software.