52 lines
870 B
Markdown
52 lines
870 B
Markdown
# FEDEO Docs Site (Docusaurus)
|
|
|
|
Diese Docusaurus-App rendert die versionierte FEDEO-Dokumentation aus dem Ordner `../docs`.
|
|
|
|
## Lokale Entwicklung
|
|
|
|
Im Ordner `docs-site` ausführen:
|
|
|
|
```bash
|
|
npm install
|
|
npm run start
|
|
```
|
|
|
|
Danach ist die Seite unter `http://localhost:3005` erreichbar.
|
|
|
|
## Statischer Build
|
|
|
|
```bash
|
|
npm run build
|
|
npm run serve
|
|
```
|
|
|
|
## Deploy mit Docker Compose
|
|
|
|
Aus dem Projekt-Root:
|
|
|
|
```bash
|
|
docker compose -f docker-compose.docs.yml up -d --build
|
|
```
|
|
|
|
Standard-Port ist `3205`.
|
|
|
|
## Workflow bei Funktionsänderungen
|
|
|
|
Vor jedem Docs-Deploy:
|
|
|
|
1. Technische Kataloge aktualisieren
|
|
|
|
```bash
|
|
node docs/scripts/sync-funktionsdoku.mjs
|
|
```
|
|
|
|
2. Änderungen committen
|
|
3. Docs-Container neu bauen und starten
|
|
|
|
## Wichtige Platzhalter
|
|
|
|
Bitte in `docs-site/docusaurus.config.ts` anpassen:
|
|
|
|
- `url` auf die echte Docs-Domain
|
|
- GitHub-Links (`editUrl`, `Repository`)
|