skilld
All skills
antfu avatar

/vitepress

@d02c484 official
by Anthony Fuantfu/skills5.9k stars
335

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

Ask your Agent

Use this Skill: https://skilld.dev/gh/antfu/skills/vitepress

This session only. Nothing lands on disk.

referencescore-cli.md

≈636 tokens on demand. Your agent reads this file only when SKILL.md points to it.

CLI Commands

VitePress provides four main commands: dev, build, preview, and init.

Development Server

Start the dev server with hot module replacement:

# In current directory (dev command is optional)
vitepress

# Or explicitly
vitepress dev

# With project in subdirectory
vitepress dev docs

Options:

Option Description
--open [path] Open browser on startup
--port <port> Specify port number
--base <path> Override base URL
--cors Enable CORS
--strictPort Exit if port is in use
--force Ignore cache and re-bundle 
vitepress dev docs --port 3000 --open

Production Build

Build static files for production:

vitepress build docs

Options:

Option Description
--base <path> Override base URL
--assetsBase <url> URL prefix generated assets are served from, e.g. a CDN (v2)
--target <target> Transpile target (default: modules)
--outDir <dir> Output directory (relative to cwd)
--assetsInlineLimit <n> Asset inline threshold in bytes
--mpa Build in MPA mode (no client hydration) 
vitepress build docs --outDir dist

Preview Production Build

Locally preview the production build:

vitepress preview docs

Options:

Option Description
--port <port> Specify port number
--base <path> Override base URL
--assetsBase <url> URL prefix generated assets are served from (v2) 
vitepress preview docs --port 4173

Initialize Project

Start the setup wizard:

vitepress init

This creates the basic file structure:

  • .vitepress/config.js - Configuration
  • index.md - Home page
  • Optional example pages

Package.json Scripts

Typical scripts configuration:

{
  "scripts": {
    "docs:dev": "vitepress dev docs",
    "docs:build": "vitepress build docs",
    "docs:preview": "vitepress preview docs"
  }
}

Key Points

  • Dev server runs at http://localhost:5173 by default
  • Preview server runs at http://localhost:4173
  • Production output goes to .vitepress/dist by default
  • The docs argument specifies the project root directory
  • Use --base to override base path without modifying config
<!-- Source references: - https://vitepress.dev/reference/cli -->

Source: SKILL.md on GitHub

Third-party checks

No alerts2d5 checks · Risk SAFE
  • Gen Agent Trust Hub2d

    The skill provides comprehensive documentation and configuration examples for VitePress, a static site generator. No malicious patterns or intent were detected. A minor surface for indirect prompt injection was identified due to the documented features for ingesting external data during the site build process, which is inherent to the framework's functionality.

  • Socket2d

    No alerts

  • Snyk2d

    Risk: LOW · No issues

  • Runlayer7mo

    2/16 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at d02c484. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 days ago.

Activeupdated 4 days ago

Capability

Other metadata
metadata
{
  "author": "Anthony Fu",
  "version": "2026.9.25",
  "source": "Generated from https://github.com/vuejs/vitepress, scripts located at https://github.com/antfu/skills"
}

Topics

README badge

README badge for antfu/skills/vitepress

What it does

VitePress is a static site generator built on Vite and Vue 3 that converts Markdown files into a fast single-page application, with file-based routing and built-in support for Vue components directly in Markdown. Use it for documentation sites, blogs, and marketing pages where you need configurable themes, syntax-highlighted code blocks, and instant hot-reload during development.

Generated from the current SKILL.md.

Frequently asked

Does VitePress work with Vue components embedded in Markdown?
Yes. Vue components work directly in Markdown files, and you can use script setup and directives within Markdown content.
Can I build a multi-language documentation site with VitePress?
Yes. VitePress includes internationalization support with locale configuration for building multi-language sites.
What search options does VitePress provide?
VitePress includes built-in local search or integration with Algolia for full-text search across documentation.
Can I customize the default theme or build a custom one from scratch?
Yes. You can extend the default theme via CSS variables and slots, or build a completely custom theme by implementing the theme interface.
Does VitePress support dynamic route generation?
Yes. You can generate pages from data at build time using createContentLoader and paths loader files for dynamic routing.

Generated from the current SKILL.md. These answers refresh after source changes.