Introduction

What is SVOCS

SVOCS is a markdown-first documentation site generator built on SvelteKit and Svelte 5. Write plain Markdown, drop in live Svelte components exactly where you need them, and ship a fully static site with almost no client-side JavaScript.

Why SVOCS

• Markdown-first, components when you need them. .md files are plain prose. Switch a file to .svx and it can import and render real Svelte components inline.
• File-system routing. content/ maps directly to /docs/* — no route config to maintain.
• Zero-config search. Every build indexes your docs with Pagefind. No server, no API keys.
• Static output. Every page prerenders via adapter-static. The Svelte compiler moves work to build time, so readers download very little JavaScript.
• Runes-first. Sidebar state, theme, search — all built on Svelte 5 runes, no legacy stores.

How the pieces fit together

content/            Your markdown source
  _meta.json        Sidebar ordering, titles, and category labels
  getting-started.md
src/lib/core/       Content pipeline: parsing, page-map, metadata
src/lib/themes/docs/ The docs theme: sidebar, search, TOC

_meta.json is the file worth understanding first — it controls everything about how your sidebar looks, independent of your file names. The Navigation guide covers it in full, including how to group pages under non-clickable category labels like the ones in this sidebar.

Next steps

Head to Quick Start to scaffold your first page, or jump straight to Navigation if you already have content and just want to organize it.