mcpField
V
vitepress

vitepress

github.com/liangmiqwqDevelopment139 installsUpdated 1d ago
Repository

About vitepress

A skill for building documentation sites, blogs, and marketing sites with VitePress, a Vite- and Vue 3-based static site generator. It covers configuration, content, theming, and deployment.

Key features

  1. 01Markdown-based file routing
  2. 02Vue components in Markdown
  3. 03Local or Algolia search
  4. 04Data loading and dynamic routes
  5. 05Theme customization and internationalization
  6. 06Build and deployment guidance

Use cases

  1. 01Creating a documentation site from Markdown
  2. 02Building a blog with Vue-enhanced content
  3. 03Configuring a multilingual VitePress site
  4. 04Preparing a site for deployment

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/liangmiqwq/skills --skill vitepress

After installing, type/vitepressin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

GENERATION.md
references/
advanced-i18n.md
advanced-ssr.md
core-cli.md
core-config.md
core-markdown.md
core-routing.md
features-code-blocks.md
features-data-loading.md
features-dynamic-routes.md
features-vue.md
recipes-deploy.md
theme-config.md
theme-custom.md
theme-customization.md

Details

From the project README

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
CLICommand-line interface: dev, build, preview, initcore-cli
RoutingFile-based routing, source directory, rewritescore-routing
MarkdownFrontmatter, containers, tables, anchors, includescore-markdown

Features

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

Theme

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

Advanced

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

Recipes

TopicDescriptionReference
DeploymentGitHub Pages, Netlify, Vercel, Cloudflare, Nginxrecipes-deploy

Comments

Markdown supported