Deft
Ask AI

Search

Search skills, authors and topics

antfu / skills

vitepress

VitePress documentation site guidance for configuration, theming, and Markdown plus Vue content.

Install

npx skills add https://github.com/antfu/skills --skill vitepress
metadata
author: Anthony Fu version: "2026.9.25" source: Generated from https://github.com/vuejs/vitepress, scripts located at https://github.com/antfu/skills

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

TopicDescriptionReference
ConfigurationConfig file setup, defineConfig, site metadatacore-config [blocked]
CLICommand-line interface: dev, build, preview, initcore-cli [blocked]
RoutingFile-based routing, source directory, rewritescore-routing [blocked]
MarkdownFrontmatter, containers, tables, anchors, includescore-markdown [blocked]

Features

Code & Content

TopicDescriptionReference
Code BlocksSyntax highlighting, line highlighting, diffs, focusfeatures-code-blocks [blocked]
Vue in MarkdownComponents, script setup, directives, templatingfeatures-vue [blocked]
Data LoadingBuild-time data loaders, createContentLoaderfeatures-data-loading [blocked]
Dynamic RoutesGenerate pages from data, paths loader filesfeatures-dynamic-routes [blocked]

Theme

TopicDescriptionReference
Theme ConfigNav, sidebar, search, social links, footertheme-config [blocked]
CustomizationCSS variables, slots, fonts, global componentstheme-customization [blocked]
Custom ThemeBuilding themes from scratch, theme interfacetheme-custom [blocked]

Advanced

TopicDescriptionReference
InternationalizationMulti-language sites, locale configurationadvanced-i18n [blocked]
SSR CompatibilityServer-side rendering, ClientOnly, dynamic importsadvanced-ssr [blocked]

Recipes

TopicDescriptionReference
DeploymentGitHub Pages, Netlify, Vercel, Cloudflare, Nginxrecipes-deploy [blocked]