vitepress

Build and configure VitePress static documentation sites with Vue-powered Markdown.

Updated Sep 17, 2026
One-click install
npx skills add https://github.com/bramanda48/skills --skill vitepress-bramanda48
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vitepress
Source: https://github.com/bramanda48/skills/tree/main/skills/vitepress
Command: npx skills add https://github.com/bramanda48/skills --skill vitepress-bramanda48

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Building documentation sites with VitePress involves many moving parts—configuration, routing, theming, Markdown extensions, SSR constraints, and deployment—and this Skill provides structured guidance for each of these tasks. ## Core Features & Use Cases - Site Configuration & Routing: Set up defineConfig, file-based routing, clean URLs, rewrites, and base paths for sub-path deployments. - Markdown & Vue Authoring: Use custom containers, code groups, line highlighting, data loaders, dynamic routes, and Vue components directly in Markdown. - Theming & Deployment: Customize the default theme with CSS variables and slots, build custom themes, handle SSR compatibility, and deploy to GitHub Pages, Netlify, Vercel, or Nginx. - Use Case: You need to create a multi-language documentation site with a blog index generated from Markdown files and deploy it to GitHub Pages—this Skill walks through locales config, createContentLoader, and the GitHub Actions workflow. ## Quick Start Use the vitepress skill to help me configure a VitePress documentation site with a custom theme and deploy it to GitHub Pages.

Frequently Asked Questions about vitepress

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure a VitePress documentation site?

Create a `.vitepress/config.ts` file and export `defineConfig` with your site title, description, base path, and themeConfig for nav and sidebar. The config supports TypeScript intellisense and can also be an async function for dynamic configuration.

How do I use Vue components in VitePress Markdown files?

VitePress Markdown files are compiled as Vue SFCs, so you can add `<script setup>` blocks, import components, and use interpolation and directives directly. Register global components in `.vitepress/theme/index.ts` via `enhanceApp` for use across all pages.

Does VitePress support multi-language documentation sites?

Yes, VitePress supports i18n through the `locales` config object, where each locale can override title, description, and themeConfig. It also supports localized search translations and experimental RTL via the `dir: 'rtl'` option with a PostCSS plugin.

Why does my VitePress build fail with 'window is not defined'?

This error occurs when code accesses browser APIs at module level during server-side rendering. Move browser-only code into `onMounted`, wrap components in `<ClientOnly>`, or use `defineClientComponent` for libraries that access the DOM on import.

How do I deploy a VitePress site to GitHub Pages?

Set the `base` config to your repository name, then add a GitHub Actions workflow that runs `npm run docs:build` and deploys the `docs/.vitepress/dist` output using `actions/deploy-pages`. Enable GitHub Pages with 'GitHub Actions' as the source in repository settings.