<!--
Sitemap:
- [What is Vocs](/guide/what-is-vocs): Learn what Vocs provides for documentation sites
- [Getting Started](/guide/getting-started): Install Vocs and create your first documentation site
- [Writing Docs with AI](/guide/writing-docs-with-ai): Use an AI agent to create and maintain Vocs documentation
- [Project Structure](/guide/structure): Overview of the structure of a Vocs project
- [Markdown Extensions](/guide/markdown-extensions): Features and syntax of Markdown in Vocs
- [Code & Syntax Highlighting](/guide/syntax-highlighting): Rich markup and annotations for code
- [Code Snippets](/guide/code-snippets): Include and reuse code in Markdown
- [Markdown Snippets](/guide/markdown-snippets): Include other Markdown files in MDX
- [Asset Handling](/guide/asset-handling): Manage images, fonts, icons, and other docs assets
- [Frontmatter](/guide/frontmatter): Configure page metadata, layouts, search, and UI visibility
- [Using React in Markdown](/guide/react): Compose MDX pages with React components
- [Twoslash](/guide/twoslash): Add type-aware annotations to code examples
- [Sidebar & Top Navigation](/guide/navigation): Keep docs navigation synced with routes
- [Theming](/guide/theming): Customize colors, typography, spacing, logos, and code themes
- [Tailwind CSS](/guide/tailwind): Use Tailwind utilities in Vocs pages and components
- [Layouts](/guide/layouts): Choose and customize page shells for your docs
- [Dynamic OG Images](/guide/dynamic-og-images): Generate social preview images from page metadata
- [Feedback](/guide/feedback): Collect page-level feedback from readers
- [Changelog Generation](/guide/changelog-generation): Fetch release notes and render a changelog page
- [MCP Server](/guide/mcp-server): Expose your docs and source code to AI assistants
- [AI Support](/guide/ai-support): Make your documentation easier for AI assistants to read
- [Site Configuration](/reference/site-config): Reference for options accepted by defineConfig
- [Components](/reference/components): Reference for the public React components exported from Vocs
- [Hooks](/reference/hooks): Reference for the React hooks exported from Vocs
- [Changelog](/guide/changelog): Release history for Vocs
-->

# What is Vocs \[Learn what Vocs provides for documentation sites]

Vocs is a portable documentation framework powered by [Vite](https://vitejs.dev) and [Waku](https://waku.gg).

Vocs reads content from `src/pages`, config from `vocs.config.ts`, and builds a docs site with file-based routes, MDX support, and a built-in UI.

Pages can be written in Markdown, MDX, or React components, so you can mix prose with demos and custom UI.

## Why Vocs

Vocs is built for documentation that lives alongside your codebase. You keep pages in the repo, configure the site in TypeScript, and use file-based routes by default.

It comes built-in with [code and syntax highlighting](/guide/syntax-highlighting), [code snippets](/guide/code-snippets), [Twoslash support](/guide/twoslash), [AI features](/guide/ai-support), [dynamic OpenGraph images](/guide/dynamic-og-images), and more.

## Vite & Waku

Vocs is built on top of Vite and Waku.

Vite provides the dev server, build pipeline, and plugin foundation. Waku provides the React app model that Vocs uses for routing and rendering.

Continue with [Getting Started](/guide/getting-started) to create a site.