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.
Baseline: VitePress 1.6.x stable (references below target 1.x). VitePress 2.0 is in alpha (Vite 8/Rolldown-based) — for 2.0-alpha projects verify config options against the 2.0 changelog before applying 1.x advice.
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 |
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.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> Baseline: VitePress 1.6.x stable (references below target 1.x). VitePress 2.0 is in alpha (Vite 8/Rolldown-based) — for 2.0-alpha projects verify config options against the 2.0 changelog before applying 1.x advice.910**Key Characteristics:**11- File-based routing with `.md` files12- Vue components work directly in Markdown13- Fast HMR with instant updates (<100ms)14- Default theme optimized for documentation15- Built-in search (local or Algolia)1617**Before working with VitePress projects:**18- Check `.vitepress/config.ts` for site configuration19- Look at `.vitepress/theme/` for custom theme extensions20- The `public/` directory contains static assets served as-is2122> The skill is based on VitePress 1.x, generated at 2026-01-28.2324## Core2526| Topic | Description | Reference |27|-------|-------------|-----------|28| Configuration | Config file setup, defineConfig, site metadata | [core-config](references/core-config.md) |29| CLI | Command-line interface: dev, build, preview, init | [core-cli](references/core-cli.md) |30| Routing | File-based routing, source directory, rewrites | [core-routing](references/core-routing.md) |31| Markdown | Frontmatter, containers, tables, anchors, includes | [core-markdown](references/core-markdown.md) |3233## Features3435### Code & Content3637| Topic | Description | Reference |38|-------|-------------|-----------|39| Code Blocks | Syntax highlighting, line highlighting, diffs, focus | [features-code-blocks](references/features-code-blocks.md) |40| Vue in Markdown | Components, script setup, directives, templating | [features-vue](references/features-vue.md) |41| Data Loading | Build-time data loaders, createContentLoader | [features-data-loading](references/features-data-loading.md) |42| Dynamic Routes | Generate pages from data, paths loader files | [features-dynamic-routes](references/features-dynamic-routes.md) |4344## Theme4546| Topic | Description | Reference |47|-------|-------------|-----------|48| Theme Config | Nav, sidebar, search, social links, footer | [theme-config](references/theme-config.md) |49| Customization | CSS variables, slots, fonts, global components | [theme-customization](references/theme-customization.md) |50| Custom Theme | Building themes from scratch, theme interface | [theme-custom](references/theme-custom.md) |5152## Advanced5354| Topic | Description | Reference |55|-------|-------------|-----------|56| Internationalization | Multi-language sites, locale configuration | [advanced-i18n](references/advanced-i18n.md) |57| SSR Compatibility | Server-side rendering, ClientOnly, dynamic imports | [advanced-ssr](references/advanced-ssr.md) |5859## Recipes6061| Topic | Description | Reference |62|-------|-------------|-----------|63| Deployment | GitHub Pages, Netlify, Vercel, Cloudflare, Nginx | [recipes-deploy](references/recipes-deploy.md) |
KIMJINWOO4