vitepress

VitePress static site generator powered by Vite and Vue. Use when building documentation sites, configuring themes, or writing Markdown with Vue components.

Category
Engineering
Skill
197 of 261
Source
Kevin wiki

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

TopicDescriptionReference
ConfigurationConfig file setup, defineConfig, site metadatacore-config (references/core-config.md)
CLICommand-line interface: dev, build, preview, initcore-cli (references/core-cli.md)
RoutingFile-based routing, source directory, rewritescore-routing (references/core-routing.md)
MarkdownFrontmatter, containers, tables, anchors, includescore-markdown (references/core-markdown.md)

Features

Code & Content

TopicDescriptionReference
Code BlocksSyntax highlighting, line highlighting, diffs, focusfeatures-code-blocks (references/features-code-blocks.md)
Vue in MarkdownComponents, script setup, directives, templatingfeatures-vue (references/features-vue.md)
Data LoadingBuild-time data loaders, createContentLoaderfeatures-data-loading (references/features-data-loading.md)
Dynamic RoutesGenerate pages from data, paths loader filesfeatures-dynamic-routes (references/features-dynamic-routes.md)

Theme

TopicDescriptionReference
Theme ConfigNav, sidebar, search, social links, footertheme-config (references/theme-config.md)
CustomizationCSS variables, slots, fonts, global componentstheme-customization (references/theme-customization.md)
Custom ThemeBuilding themes from scratch, theme interfacetheme-custom (references/theme-custom.md)

Advanced

TopicDescriptionReference
InternationalizationMulti-language sites, locale configurationadvanced-i18n (references/advanced-i18n.md)
SSR CompatibilityServer-side rendering, ClientOnly, dynamic importsadvanced-ssr (references/advanced-ssr.md)

Recipes

TopicDescriptionReference
DeploymentGitHub Pages, Netlify, Vercel, Cloudflare, Nginxrecipes-deploy (references/recipes-deploy.md)