florianfederspiel
8c458f4953
All checks were successful
Build and Push Docker Images / verify-docs-sync (push) Successful in 9s
Build and Push Docker Images / build-backend (push) Successful in 14s
Build and Push Docker Images / build-frontend (push) Successful in 13s
Build and Push Docker Images / build-docs (push) Successful in 1m47s
35 lines
695 B
Markdown
35 lines
695 B
Markdown
# FEDEO Docs Site (Nuxt Content)
|
|
|
|
Diese Docs-App basiert auf Nuxt Content und rendert die Inhalte aus dem Repository-Ordner `docs/`.
|
|
|
|
## Lokale Entwicklung
|
|
|
|
Im Ordner `docs-site` ausführen:
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
Die App ist danach unter `http://localhost:3005` erreichbar.
|
|
|
|
## Build
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## Production-Deploy
|
|
|
|
Das Docker-Image startet einen Node-Server auf Port `3000`.
|
|
In der Haupt-`docker-compose.yml` wird die App hinter Traefik unter `/docs` veröffentlicht.
|
|
|
|
## Content-Quelle
|
|
|
|
Vor `dev` und `build` wird automatisch synchronisiert:
|
|
|
|
- Quelle: `../docs/**/*.md`
|
|
- Ziel: `docs-site/content`
|
|
|
|
Dabei wird `docs/README.md` zu `content/index.md` gemappt.
|