Krate Docs

Deployment

Because Krate is SSG-first, most sites are just a folder of static files.

Static hosts (Netlify, Vercel, GitHub Pages, S3, …)

  1. Build locally or in CI: krate build
  2. Deploy the dist/ directory.
dist/ ← deploy this

Any static host works. The output has no server runtime dependency — pages are pre-rendered HTML with hashed JS/CSS assets.

Node servers (SSR / ISR / API routes / middleware)

If your site uses SSR, ISR, streaming, JS API routes, or middleware, you need the Node sidecars. Run the built site with krate serve or wire the output into your own Node process:

krate build krate serve # serves dist + sidecars

manifest.json records per-page modes so the runtime knows which routes need the renderer.

Docker

FROM node:20-slim AS build WORKDIR /app COPY . . RUN npm install -g @krate/core && krate build FROM nginx:alpine COPY --from=build /app/dist /usr/share/nginx/html

For SSR/ISR/API deployments, use a Node base image and run krate serve as the container command instead of nginx.

CI

steps: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: { node-version: 20 } - run: npm install -g @krate/core - run: krate build - uses: actions/upload-pages-artifact@v3 with: { path: dist }

Notes

  • WASM search — the docs search module (docs/search/docfind_bg.wasm) is a static asset; make sure your host serves .wasm with Content-Type: application/wasm. Most hosts do by default; the search UI falls back to the JSON index if not.
  • Trailing slashes — routes are emitted as directory index files (/docs/foo/index.html), so both /docs/foo and /docs/foo/ work on hosts with clean-URL rewriting.
PreviousCustomizing the Docs SiteNextContributing