mcpField
V
vitepress

vitepress

github.com/hairyfDevelopment26104 installsUpdated 4w ago
Repository

About vitepress

VitePress is a skill for building and maintaining documentation, blogs, and marketing sites with VitePress 1.x. It organizes guidance on configuration, Markdown, routing, themes, and deployment.

Key features

  1. 01Configuration and CLI guidance
  2. 02File-based routing and Markdown
  3. 03Vue components in Markdown
  4. 04Theme customization and search
  5. 05Internationalization and deployment

Use cases

  1. 01Creating a VitePress documentation site
  2. 02Adding custom themes and Vue content
  3. 03Configuring multilingual sites
  4. 04Preparing static site deployment

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/hairyf/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 1.x, generated at 2026-01-28.

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