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 2.0.0-alpha.20, generated at 2026-09-25.
VitePress 2 notes (v1 → v2): install with vitepress@next; requires Node.js 22+. defineConfigWithTheme is deprecated — use defineConfig<ThemeConfig>. Native RTL support (dir option, CSS logical properties) replaces the old PostCSS-plugin approach. Built-in iconify pipeline (icons config, useIcon/VPIcon, collection:name social icons). New assetsBase (CDN) and assetsShards build options; metaChunk removed. Markdown image.lazyLoading renamed to image.lazyLoad.
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: vitepress-23description: VitePress static site generator powered by Vite and Vue. Use when building documentation sites, configuring themes, or writing Markdown with Vue components.4metadata:5 author: Anthony Fu6 version: "2026.9.25"7 source: https://skillmd.com/skills/pleaseai/vitepress-28 upstream: Generated from https://github.com/vuejs/vitepress, scripts located at https://github.com/antfu/skills9---1011VitePress 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.1213**Key Characteristics:**14- File-based routing with `.md` files15- Vue components work directly in Markdown16- Fast HMR with instant updates (<100ms)17- Default theme optimized for documentation18- Built-in search (local or Algolia)1920**Before working with VitePress projects:**21- Check `.vitepress/config.ts` for site configuration22- Look at `.vitepress/theme/` for custom theme extensions23- The `public/` directory contains static assets served as-is2425> The skill is based on VitePress 2.0.0-alpha.20, generated at 2026-09-25.2627**VitePress 2 notes (v1 → v2):** install with `vitepress@next`; requires Node.js 22+. `defineConfigWithTheme` is deprecated — use `defineConfig<ThemeConfig>`. Native RTL support (`dir` option, CSS logical properties) replaces the old PostCSS-plugin approach. Built-in iconify pipeline (`icons` config, `useIcon`/`VPIcon`, `collection:name` social icons). New `assetsBase` (CDN) and `assetsShards` build options; `metaChunk` removed. Markdown `image.lazyLoading` renamed to `image.lazyLoad`.2829## Core3031| Topic | Description | Reference |32|-------|-------------|-----------|33| Configuration | Config file setup, defineConfig, site metadata | [core-config](references/core-config.md) |34| CLI | Command-line interface: dev, build, preview, init | [core-cli](references/core-cli.md) |35| Routing | File-based routing, source directory, rewrites | [core-routing](references/core-routing.md) |36| Markdown | Frontmatter, containers, tables, anchors, includes | [core-markdown](references/core-markdown.md) |3738## Features3940### Code & Content4142| Topic | Description | Reference |43|-------|-------------|-----------|44| Code Blocks | Syntax highlighting, line highlighting, diffs, focus | [features-code-blocks](references/features-code-blocks.md) |45| Vue in Markdown | Components, script setup, directives, templating | [features-vue](references/features-vue.md) |46| Data Loading | Build-time data loaders, createContentLoader | [features-data-loading](references/features-data-loading.md) |47| Dynamic Routes | Generate pages from data, paths loader files | [features-dynamic-routes](references/features-dynamic-routes.md) |4849## Theme5051| Topic | Description | Reference |52|-------|-------------|-----------|53| Theme Config | Nav, sidebar, search, social links, footer | [theme-config](references/theme-config.md) |54| Customization | CSS variables, slots, fonts, global components | [theme-customization](references/theme-customization.md) |55| Custom Theme | Building themes from scratch, theme interface | [theme-custom](references/theme-custom.md) |5657## Advanced5859| Topic | Description | Reference |60|-------|-------------|-----------|61| Internationalization | Multi-language sites, locale configuration | [advanced-i18n](references/advanced-i18n.md) |62| SSR Compatibility | Server-side rendering, ClientOnly, dynamic imports | [advanced-ssr](references/advanced-ssr.md) |6364## Recipes6566| Topic | Description | Reference |67|-------|-------------|-----------|68| Deployment | GitHub Pages, Netlify, Vercel, Cloudflare, Nginx | [recipes-deploy](references/recipes-deploy.md) |