What is this?
VitePress is a Vue-powered static site generator built on top of Vite — the spiritual successor to VuePress, aimed mainly at documentation sites.
VitePress is a Vue-powered static site generator built on top of Vite — the spiritual successor to VuePress, aimed mainly at documentation sites.So is it a tool I build a site with, or a library I add code to?A build tool: you run it over your Markdown and Vue content and it compiles a ready-to-serve static website. Visitors just get plain web pages — none of it runs on a server for them.
A build tool: you run it over your Markdown and Vue content and it compiles a ready-to-serve static website. Visitors just get plain web pages — none of it runs on a server for them.If I want to build a docs site with it, where do I begin?The README itself skips install commands and points to the official docs at vitepress.dev — the Getting Started guide there walks you through creating and building a new site.
The README itself skips install commands and points to the official docs at vitepress.dev — the Getting Started guide there walks you through creating and building a new site.Where can the finished site be hosted?Anywhere that serves static files, since the output is plain web pages. The VitePress team hosts its own site on Netlify, which also provides deploy previews for their pull requests.
Anywhere that serves static files, since the output is plain web pages. The VitePress team hosts its own site on Netlify, which also provides deploy previews for their pull requests.Can I use it in commercial projects, and is it free?Yes — VitePress is MIT-licensed, so it is free to use, modify, and ship in commercial products. Copyright belongs to Yuxi (Evan) You.
Yes — VitePress is MIT-licensed, so it is free to use, modify, and ship in commercial products. Copyright belongs to Yuxi (Evan) You.How is VitePress related to VuePress?It is the spiritual successor to VuePress: the same Vue-powered site generator idea, rebuilt on top of Vite. It lives as its own project under the vuejs GitHub organization, not as a VuePress release.
It is the spiritual successor to VuePress: the same Vue-powered site generator idea, rebuilt on top of Vite. It lives as its own project under the vuejs GitHub organization, not as a VuePress release.Does a VitePress site get search out of the box?Yes — search comes via Algolia's DocSearch integration, and the DocSearch client packages ship as direct dependencies of VitePress itself. Algolia's team partners with the project to maintain the integration.
Yes — search comes via Algolia's DocSearch integration, and the DocSearch client packages ship as direct dependencies of VitePress itself. Algolia's team partners with the project to maintain the integration.Can I try it without installing anything?Yes — the project's playground runs in the browser on StackBlitz's WebContainers technology, and pull requests get instant preview releases, so you can poke at VitePress straight from a browser tab.
Yes — the project's playground runs in the browser on StackBlitz's WebContainers technology, and pull requests get instant preview releases, so you can poke at VitePress straight from a browser tab.What are similar projects?vuepress, framework, react-static, nextra, core, nuxt, cheatsheets, vue-cli
vuepress, framework, react-static, nextra, core, nuxt, cheatsheets, vue-cliWhich topics is it in?ssg, vuejs, static-site-generator, vite, vue, documentation, markdown, web-development, command-line-tool, free, frontend, tool
ssg, vuejs, static-site-generator, vite, vue, documentation, markdown, web-development, command-line-tool, free, frontend, tool