Persmonitor Docs

Appearance

docs.persmonitor.nl ​

VitePress-documentatiesite voor Persmonitor (GraphQL API docs). Live op docs.persmonitor.nl via Harbor-image + GitOps (branch main).

De docs staan in de root van deze repo (.vitepress/, guide/, reference/, index.md). Bij deploy wordt npm run docs:build uitgevoerd en de output (.vitepress/dist) wordt door nginx geserveerd. Push naar main triggert de Forgejo-build (.forgejo/workflows/build.yaml).

API voor AI/LLM (publiek): Bronbestand reference/api-for-llms.md → /api-spec.md via scripts/sync-api-spec.js (predocs:build).
Volledige spec (intern/VPN): internal/api-for-llms.md (niet gesynchroniseerd naar public).

Ontwikkelen ​

bash
npm install
npm run docs:dev

Open http://localhost:5173. Build: npm run docs:build, preview: npm run docs:preview.

Lokaal testen met Docker ​

bash
docker build -t docs-persmonitor .
docker run -p 8080:80 docs-persmonitor

Open http://localhost:8080

Deployen op Coolify ​

Deze app is klaar voor Coolify: Dockerfile, nginx op PORT, en geen extra config in de repo nodig.

Stappen in Coolify ​

  1. Nieuwe resource → kies je Git-repository (de repo waarin docs.persmonitor.nl staat).
  2. Build Pack → kies Dockerfile (niet Nixpacks/Static).
  3. Base directory:
    • Als deze map de hele repo is: / (root).
    • Als dit een submap is (bv. monorepo Persmonitor): docs.persmonitor.nl.
  4. Klik Continue en ga naar Network.
  5. Domain: docs.persmonitor.nl (of meerdere, komma-gescheiden).
  6. Port: zet op 80. (Coolify standaard is 3000; deze container luistert op poort 80.)
  7. Deploy.

Coolify bouwt met de Dockerfile en start de container; nginx luistert op de geconfigureerde poort. SSL (Let’s Encrypt) kun je in Coolify aanzetten als het domein naar je server wijst (A-record of CNAME).