VitePress is a Static Site Generator (SSG) built on Vite and Vue 3. It takes Markdown content, applies a theme, and generates static HTML that becomes an SPA for fast navigation. Perfect for documentation, blogs, and marketing sites.
Key Characteristics:
- File-based routing with
.md files
- Vue components work directly in Markdown
- Fast HMR with instant updates (<100ms)
- Default theme optimized for documentation
- Built-in search (local or Algolia)
Before working with VitePress projects:
- Check
.vitepress/config.ts for site configuration
- Look at
.vitepress/theme/ for custom theme extensions
- The
public/ directory contains static assets served as-is
The skill is based on VitePress 1.x, generated at 2026-01-28.
Core
| Topic |
Description |
Reference |
| Configuration |
Config file setup, defineConfig, site metadata |
core-config |
| CLI |
Command-line interface: dev, build, preview, init |
core-cli |
| Routing |
File-based routing, source directory, rewrites |
core-routing |
| Markdown |
Frontmatter, containers, tables, anchors, includes |
core-markdown |
Features
Code & Content
| Topic |
Description |
Reference |
| Code Blocks |
Syntax highlighting, line highlighting, diffs, focus |
features-code-blocks |
| Vue in Markdown |
Components, script setup, directives, templating |
features-vue |
| Data Loading |
Build-time data loaders, createContentLoader |
features-data-loading |
| Dynamic Routes |
Generate pages from data, paths loader files |
features-dynamic-routes |
Theme
| Topic |
Description |
Reference |
| Theme Config |
Nav, sidebar, search, social links, footer |
theme-config |
| Customization |
CSS variables, slots, fonts, global components |
theme-customization |
| Custom Theme |
Building themes from scratch, theme interface |
theme-custom |
Advanced
| Topic |
Description |
Reference |
| Internationalization |
Multi-language sites, locale configuration |
advanced-i18n |
| SSR Compatibility |
Server-side rendering, ClientOnly, dynamic imports |
advanced-ssr |
Recipes
| Topic |
Description |
Reference |
| Deployment |
GitHub Pages, Netlify, Vercel, Cloudflare, Nginx |
recipes-deploy |
Converted and distributed by TomeVault — claim your Tome and manage your conversions.
1---2name: vitepress3description: VitePress static site generator powered by Vite and Vue. Use when building documentation sites, configuring themes, or writing Markdown with Vue components. Use when this capability is needed.4---56VitePress is a Static Site Generator (SSG) built on Vite and Vue 3. It takes Markdown content, applies a theme, and generates static HTML that becomes an SPA for fast navigation. Perfect for documentation, blogs, and marketing sites.78**Key Characteristics:**9- File-based routing with `.md` files10- Vue components work directly in Markdown11- Fast HMR with instant updates (<100ms)12- Default theme optimized for documentation13- Built-in search (local or Algolia)1415**Before working with VitePress projects:**16- Check `.vitepress/config.ts` for site configuration17- Look at `.vitepress/theme/` for custom theme extensions18- The `public/` directory contains static assets served as-is1920> The skill is based on VitePress 1.x, generated at 2026-01-28.2122## Core2324| Topic | Description | Reference |25|-------|-------------|-----------|26| Configuration | Config file setup, defineConfig, site metadata | [core-config](references/core-config.md) |27| CLI | Command-line interface: dev, build, preview, init | [core-cli](references/core-cli.md) |28| Routing | File-based routing, source directory, rewrites | [core-routing](references/core-routing.md) |29| Markdown | Frontmatter, containers, tables, anchors, includes | [core-markdown](references/core-markdown.md) |3031## Features3233### Code & Content3435| Topic | Description | Reference |36|-------|-------------|-----------|37| Code Blocks | Syntax highlighting, line highlighting, diffs, focus | [features-code-blocks](references/features-code-blocks.md) |38| Vue in Markdown | Components, script setup, directives, templating | [features-vue](references/features-vue.md) |39| Data Loading | Build-time data loaders, createContentLoader | [features-data-loading](references/features-data-loading.md) |40| Dynamic Routes | Generate pages from data, paths loader files | [features-dynamic-routes](references/features-dynamic-routes.md) |4142## Theme4344| Topic | Description | Reference |45|-------|-------------|-----------|46| Theme Config | Nav, sidebar, search, social links, footer | [theme-config](references/theme-config.md) |47| Customization | CSS variables, slots, fonts, global components | [theme-customization](references/theme-customization.md) |48| Custom Theme | Building themes from scratch, theme interface | [theme-custom](references/theme-custom.md) |4950## Advanced5152| Topic | Description | Reference |53|-------|-------------|-----------|54| Internationalization | Multi-language sites, locale configuration | [advanced-i18n](references/advanced-i18n.md) |55| SSR Compatibility | Server-side rendering, ClientOnly, dynamic imports | [advanced-ssr](references/advanced-ssr.md) |5657## Recipes5859| Topic | Description | Reference |60|-------|-------------|-----------|61| Deployment | GitHub Pages, Netlify, Vercel, Cloudflare, Nginx | [recipes-deploy](references/recipes-deploy.md) |6263---64> Converted and distributed by [TomeVault](https://tomevault.io/claim/antfu) — claim your Tome and manage your conversions.65<!-- tomevault:4.0:skill_md:2026-04-11 -->
tomevault-io