Skip to main content

​
Welcome to VitePress

VitePress is a Vue-powered static site generator and the spiritual successor to VuePress. Built on top of Vite, it delivers lightning-fast development experience and optimized production builds for your documentation sites.
VitePress is designed specifically for building fast, content-focused websites. It’s perfect for documentation, blogs, and marketing sites.

​
Why VitePress?

VitePress combines the best of modern web development:

Lightning Fast

Powered by Vite for instant server start and lightning-fast hot module replacement (HMR)

Vue-Powered

Use Vue components in Markdown and leverage the full power of Vue’s reactive system

File-Based Routing

Automatic routing based on your file structure - no configuration needed

Optimized Builds

Static HTML for each page with aggressive performance optimizations out of the box

​
Key Features

​
Built for Performance

VitePress generates static HTML for each page, then loads it as a single-page application (SPA). This approach ensures:
  • Fast initial load: Static HTML is served immediately
  • Smooth navigation: Client-side routing for instant page transitions
  • SEO friendly: Full HTML content for search engine crawlers
  • Optimized assets: Automatic code splitting and lazy loading

​
Markdown-First

Write your content in Markdown with powerful extensions:
  • GitHub-flavored markdown syntax
  • Custom containers for tips, warnings, and more
  • Code syntax highlighting with Shiki
  • Emoji support and automatic table of contents
  • Frontmatter for page metadata

​
Customizable Theme

VitePress ships with a beautiful default theme that’s ready to use:
  • Responsive design that works on all devices
  • Dark mode support out of the box
  • Algolia DocSearch integration
  • Customizable navigation and sidebar
  • Or build your own custom theme from scratch
Ready to get started? Choose your path:

Quick Start

Install VitePress and create your first site in minutes

Routing Guide

Learn how file-based routing works and how to organize your content

Deployment

Deploy your VitePress site to popular hosting platforms

Configuration

Customize your site with VitePress configuration options

​
What Makes VitePress Different?

VitePress is the spiritual successor to VuePress, rebuilt from the ground up:
  • Faster: Uses Vite instead of webpack for 10-100x faster dev server
  • Simpler: Focused specifically on documentation sites
  • Modern: Built with Vue 3 and the composition API
  • Lighter: Smaller bundle sizes and better performance

​
Example Sites

VitePress powers documentation for major projects:
  • Vite - Next generation frontend tooling
  • Vue.js - The progressive JavaScript framework
  • Vitest - Blazing fast unit test framework
  • Rollup - JavaScript module bundler
VitePress is currently in alpha. The API is stable but minor breaking changes may occur between releases.

​
System Requirements

Before you begin, make sure you have:
  • Node.js version 18 or higher
  • A terminal for accessing the VitePress CLI
  • A text editor (VS Code recommended with the Vue extension)

​
Next Steps

Ready to build your documentation site?
1

Install VitePress

Head to the Quick Start guide to install VitePress and scaffold your first project
2

Learn the Basics

Explore file-based routing and learn how to structure your content
3

Deploy Your Site

Follow the deployment guide to publish your site to the web
New to static site generators? VitePress makes it easy. Start with the Quick Start guide and you’ll have a site running in minutes.

Build docs developers (and LLMs) love

Get started for freeTalk to us