vitepress

Convert Markdown files into static documentation sites with Vue components.

302|22|Updated Feb 12, 2026
One-click install
npx skills add https://github.com/JetBrains/skills --skill vitepress-jetbrains
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vitepress
Source: https://github.com/JetBrains/skills/tree/main/vitepress
Command: npx skills add https://github.com/JetBrains/skills --skill vitepress-jetbrains

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

VitePress streamlines building high-performance documentation sites by rendering Markdown content into static HTML with Vue-powered themes and fast navigation.

Core Features & Use Cases

  • File-based routing with Markdown, and Vue components work directly in Markdown for docs, blogs, and marketing pages.
  • Built-in search, fast HMR, and a configurable default theme optimized for documentation.
  • Simple configuration through .vitepress/config.ts with theme extensions and customizations.

Quick Start

Set up a docs folder with a .vitepress/config.ts and run the dev server to start building docs.

Frequently Asked Questions about vitepress

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

FAQPage Schema
How do I use Vue components inside Markdown for a documentation site?

You can use Vue components directly in Markdown to build interactive documentation sites. VitePress renders Markdown into static HTML while allowing Vue components, enabling dynamic content within file-based routed pages.

What is the best way to build a static documentation site with Vue and Vite?

Building a static documentation site with Vue and Vite is streamlined by setting up a docs folder with a .vitepress/config.ts file. Running the dev server turns Markdown into production-ready static pages with fast HMR.

How do I configure site metadata and theme customization in VitePress?

You configure site metadata and theme customization through the .vitepress/config.ts file. This setup supports frontmatter-driven metadata, theme extensions, and customizations optimized for documentation portals.

Does VitePress support local search and file-based routing for blogs?

Yes, VitePress supports local search and file-based routing for blogs and marketing pages. Markdown files automatically generate routes, and the framework includes built-in search functionality optimized for documentation.

Can I build a marketing site using Markdown and Vue components?

You can build marketing sites using Markdown and Vue components. The framework supports frontmatter-driven site metadata and theme customization, allowing Vue components to render directly within Markdown content.

What are the limitations of using Markdown for static site generation with Vue?

Using Markdown for static site generation requires configuration through .vitepress/config.ts. While it supports Vue components and code blocks, complex dynamic applications may exceed the scope of frontmatter-driven static documentation.