Repolode
vuejs

vuejs/vitepress

A Vue- and Vite-powered static site generator for building documentation and content sites from Markdown.

Open-source alternative to:GitBook

Stars
18,427
Forks
2,752
Open issues
336
Last commit
3 days ago

What is it?

VitePress is a static site generator built on Vite and Vue. It turns Markdown files into static HTML pages and is aimed mainly at documentation sites, while still allowing Vue components to be embedded directly in Markdown content.

As a spiritual successor to VuePress, it uses Vite as its build and dev server, which keeps local startup and hot updates fast. Pages are rendered as static files that can be deployed to any static hosting service.

The project is maintained under the vuejs organization and is used to publish the official Vue ecosystem documentation sites.

Key features

  • 01Converts Markdown files into static HTML pages.
  • 02Lets you use Vue components inside Markdown content.
  • 03Uses Vite for the dev server and build pipeline.
  • 04Outputs static files that can be deployed to any static host.
  • 05Integrates DocSearch for site search.

Use cases

  • Building project documentation sites from Markdown.
  • Publishing technical blogs or knowledge bases as static sites.
  • Creating Vue-based docs that mix interactive components with prose.

Topics

FAQ

What is vitepress?
A Vue- and Vite-powered static site generator for building documentation and content sites from Markdown. VitePress is a static site generator built on Vite and Vue. It turns Markdown files into static HTML pages and is aimed mainly at documentation sites, while still allowing Vue components to be embedded directly in Markdown content.
Is vitepress free to use? What license does it have?
vitepress is open source under the MIT license. Check the license terms before using it in commercial products.
Is vitepress still maintained?
Actively maintained. The last commit to vitepress was on Oct 19, 2026.
What can I use vitepress for?
Building project documentation sites from Markdown. Publishing technical blogs or knowledge bases as static sites. Creating Vue-based docs that mix interactive components with prose.
Where can I get vitepress?
The source code and installation instructions are on GitHub: https://github.com/vuejs/vitepress

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects