# SVOCS

> Markdown-first documentation site generator built on SvelteKit and Svelte 5.

## Getting Started
- [Introduction](https://svocs.dev/docs/introduction.md): What SVOCS is, why it exists, and how the pieces fit together.
- [Quick Start](https://svocs.dev/docs/getting-started.md): Scaffold a project and ship your first page.

## Guides
- [Writing Content](https://svocs.dev/docs/writing-content.md): Frontmatter, sidecar metadata, GFM, and code blocks.
- [Components](https://svocs.dev/docs/components.md): Built-in Svelte components you can use inside .svx content.
- [Architecture](https://svocs.dev/docs/architecture.md): Content pipeline, routing strategy, and theme boundaries.
- [AI & LLMs](https://svocs.dev/docs/ai.md): llms.txt, llms-full.txt, and per-page raw markdown for AI tools.
- [Repo Analysis](https://svocs.dev/docs/repo-analysis.md): Generate baseline docs content from an existing GitHub repo, heuristically or with an AI.

## Configuration
- [Theming](https://svocs.dev/docs/theming.md): Pick an accent color during setup, or hand-edit the CSS custom properties directly.
- [Navigation](https://svocs.dev/docs/navigation.md): The _meta.json schema: ordering, titles, precedence, and category separators.

## Search
- [Search](https://svocs.dev/docs/search.md): Five interchangeable backends behind one switch — Pagefind, Orama, FlexSearch, Typesense, and Chroma.
- [Pagefind](https://svocs.dev/docs/search/pagefind.md)
- [Orama](https://svocs.dev/docs/search/orama.md)
- [FlexSearch](https://svocs.dev/docs/search/flexsearch.md)
- [Typesense](https://svocs.dev/docs/search/typesense.md)
- [Chroma](https://svocs.dev/docs/search/chroma.md)

## More
- [Deployment](https://svocs.dev/docs/deployment.md): Ship your SVOCS site as static files to any host.
- [Cloudflare Pages](https://svocs.dev/docs/deployment/cloudflare-pages.md): Deploy SVOCS to Cloudflare Pages with zero configuration.
- [GitHub Pages](https://svocs.dev/docs/deployment/github-pages.md): Publish SVOCS from your repository with GitHub Actions.
- [About](https://svocs.dev/docs/about.md): What SVOCS is and where to find it.