A complete docs UI
Top nav, sidebar tree, breadcrumbs, table of contents and heading anchors, all generated
from your file tree and ordered by one _meta.json file.
Make beautiful docs
with Svelte & Markdown
A static site generator built on SvelteKit. You write plain Markdown and get prerendered pages with almost no JavaScript; when a page needs interactivity, drop a real Svelte component into the prose.
bunx create-svocs-docs@latest Zero-config full-text search
Pagefind indexes every page at build time. Search runs in the browser, so there is no server to run and nothing to configure.
Markdown meets Svelte
Write .md for plain pages. Rename a file to .svx when it needs a live
Svelte component in the prose.
File-system routing
Folders become routes. _meta.json controls titles, order and grouping.
Runes-first reactivity
The theme, sidebar, and search dialog are built on Svelte 5 runes rather than stores.
Static export, tiny footprint
Every page prerendered with adapter-static. The Svelte compiler moves work to
build time so readers download almost nothing.
Bring your own runtime
The same project and scripts run under Bun, pnpm, Deno, or Nub. Pick whichever toolchain you already use.
Social cards for every page
Each route gets its own branded 1200×630 preview card at build time, recolored by your accent. No browser, no image service.
AI-ready out of the box
llms.txt and per-page Markdown endpoints ship with every site, and the CLI can draft
a docs baseline from an existing repo.
…and everything else you'd expect
- Table of contents
- Breadcrumbs
- Anchor links
- Reading time
- Dark / light mode
- SEO metadata + sitemap
- Copy / view as Markdown
- 5 pluggable search backends
- Accent-color theming
- Sub-path deploys
- Mermaid diagrams
- LaTeX math
Explore the starter docs
View all →- Introduction What SVOCS is, why it exists, and how the pieces fit together. →
- Quick Start Scaffold a project and ship your first page. →
- Components Built-in Svelte components you can use inside .svx content. →
- Theming Pick an accent color during setup, or hand-edit the CSS custom properties directly. →
- Search Five interchangeable backends behind one switch: Pagefind, Orama, FlexSearch, Typesense, and Chroma. →
- AI & LLMs llms.txt, llms-full.txt, and per-page raw markdown for AI tools. →
- Repo Analysis Generate baseline docs content from an existing GitHub repo, heuristically or with an AI. →
- Deployment Ship your SVOCS site as static files to any host. →
Set up your docs in a minute.
One command scaffolds a working site. Everything after that is Markdown.