About VitePress
VitePress is a static site generator built on Vite and Vue. It turns Markdown files into fast documentation sites with little configuration.
What it does
You write pages in Markdown, and VitePress builds them into static HTML. Pages then load quickly, with client-side navigation after the first visit. Vue syntax and components can be used directly inside Markdown, and you can build custom themes with Vue. The local development server starts quickly and updates pages as you edit them.
Key features
- Write pages in Markdown with Vue syntax
- Fast local server with instant updates
- Build static HTML for simple hosting
- Create custom themes with Vue components
- Move between pages without a full reload
Who it's for
VitePress fits developers who already use Vue or Vite and want documentation that matches the rest of their stack. It also suits library authors who need a clean reference site with little setup and a small amount of maintenance.
Pricing and good to know
VitePress is open source under the MIT license, so it is free to use. You build the site locally or in a continuous integration service, then host the output anywhere that serves static files. The documentation currently shows a pre-release version number, so read the release notes before you upgrade an existing site.
Highlights
- Write pages in Markdown with Vue syntax
- Run a local server that updates as you edit
- Build static HTML that loads quickly
- Create custom themes with Vue components
- Use Vite plugins in your docs project
