Quick Start

Scaffold a project

The fastest way to start is the create-svocs-docs starter, which drops in a working SVOCS site with this exact page structure — sidebar, search, theming, and all:

bunx create-svocs-docs@latest my-docs

npm create svocs-docs@latest my-docs

pnpm create svocs-docs my-docs

deno run -A npm:create-svocs-docs my-docs

Answer the prompts, then start the dev server:

cd my-docs
bun install
bun run dev

Your new site is live at http://localhost:5173.

The prompts also let you pick an accent color, a search backend, and, optionally, generate baseline content from an existing GitHub repo instead of the generic starter pages — see Theming and Repo Analysis.

Add a page

Every file under content/ becomes a route. Drop a markdown file at content/hello.md:

---
title: Hello
description: My first SVOCS page.
---

Hello from SVOCS.

Save it, and /docs/hello appears — no route file, no manual registration. The sidebar picks it up automatically, sorted alongside your other pages.

Control the sidebar

Ordering and labels come from a _meta.json file next to the pages it applies to:

{
	"items": {
		"hello": { "title": "Hello, World", "order": 1 }
	}
}

_meta.json is also how you group pages under category headings, like “Getting Started” and “Guides” in this sidebar — see Navigation for the full schema.

Build for production

bun run build

This prerenders every page with adapter-static and indexes the site with Pagefind, so bun run preview serves the exact static output you’ll deploy. See Deployment for Cloudflare Pages and GitHub Pages walkthroughs.

Next steps

• Writing Content — frontmatter, sidecar metadata, GFM, code blocks
• Components — the built-in .svx component library
• Theming — change the accent color, or the rest of the palette
• Navigation — the full _meta.json schema
• Repo Analysis — generate starter content from an existing repo, heuristically or with an AI