Skip to content

VitePress is a static site generator (SSG) designed specifically for building fast, content-centric sites. Simply put, VitePress takes content written in Markdown, applies a theme to it, and generates static HTML pages that can be easily deployed anywhere.

Differences from VuePress

FeatureVuePress v1VitePress
Build ToolWebpackVite
Dev Server PerformanceSlowerExtremely Fast
ConfigurationRelatively complexMore concise
EcosystemMature, rich pluginsRapidly developing

If you're starting a new project, consider using VitePress—it has become the preferred choice for its excellent development experience and performance.

Use Cases

VitePress is perfect for building:

  • Technical documentation
  • Personal blogs
  • Product introduction sites
  • Open source project homepages

Quick Start

Using VitePress is very simple—follow these steps to get started quickly.

  1. Create a VitePress project quickly with the following command:
bash
npm add -D vitepress
npx vitepress init

Then follow the command-line prompts to start your documentation website.

  1. Create a Markdown file, such as docs/index.md (the command above typically generates this), and write your content in it.
  2. Configure basic site information in the .vitepress/config.mts file, such as the site title, description, and logo.
  3. Start the development server with npm run docs:dev.
  4. Visit http://localhost:5173 in your browser, and VitePress will preview your site in real time.

Additionally, when you're ready to deploy your site, you can run the following command:

bash
npm run docs:build

This generates the final static files in the .vitepress/dist directory, which you can deploy to any static hosting service.

Content is for learning and research only.