SVOCS
Esc

Start typing to search the docs

Deployment

Ship your SVOCS site as static files to any host.

1 min read · 178 words

View as Markdown

Static output

SVOCS builds to plain static files, so it deploys anywhere that can serve HTML. Running the build produces a self-contained build/ directory that already includes your search index:

bun run build
# → vite build && node scripts/search/postbuild.mjs

The postbuild step dispatches to whichever search backend is active — see Search for the full list and how to switch.

Preview the exact output locally before shipping it:

bun run preview

What the build contains

  • Prerendered HTML for every docs page and the landing page
  • Hashed JS/CSS assets with immutable cache headers ready
  • Your search index — shape depends on the active backend, see Search
  • Everything from static/ copied verbatim (including .nojekyll)

Host requirements

There are none beyond static file serving — no Node server, no functions, no environment variables at runtime. The two guides in this section walk through concrete setups:

Deploying under a sub-path (like https://user.github.io/my-repo/)? Set the BASE_PATH environment variable at build time. The GitHub Pages guide covers this.