Docs/Developer/Build i wdrożenieENOBS STUDIO

FACEIT BANNER / DOCS

Build i wdrożenie

Produkcyjna wersja to zestaw statycznych plików serwowanych przez nginx. Nie ma procesu Node w produkcji.

Build

pnpm build
# = tsc && pnpm run docs && vite build
  • Vite buduje dwa wejścia: generator (index.html) i widżet (widget/index.html).
  • Wywołania console i debugger są usuwane z kodu produkcyjnego.
  • VITE_FACEIT_API_KEY jest wstawiany w czasie builda, więc musi być dostępny w środowisku builda.

Render dokumentacji (SSR)

Polecenie pnpm docs buduje src/docs/render.tsx w trybie SSR (vite build --ssr) i uruchamia wynik w Node. Skrypt renderuje strony Reactem (renderToStaticMarkup) do public/docs i public/en/docs, generuje public/sitemap.xml oraz public/llms.txt, a Vite kopiuje je do dist. Treść bierze z src/docs/content.ts i src/docs/dev-content.ts, a listy układów i parametrów liczy z kodu aplikacji. Po zmianie dokumentacji podbij DOCS_UPDATED w content.ts.

Docker i nginx

  • Dockerfile ma dwa etapy: node:22-alpine buduje aplikację, nginx:1.27-alpine serwuje katalog dist.
  • deploy/nginx.conf obsługuje /docs/, /en/docs/ i /wiki/ jako katalogi z index.html, a pozostałe ścieżki kieruje do aplikacji (fallback SPA).
  • Ścieżka /widget/ dostaje nagłówek X-Robots-Tag: noindex.
  • captain-definition wskazuje Dockerfile dla CapRover; klucz API ustawia się w App Configs jako VITE_FACEIT_API_KEY.

Otwórz generator

Zaktualizowano: