VitePress
Discouraged
Not our default choice. We recommend Docusaurus or Astro Starlight for documentation sites.
What is itโ
VitePress is a Vue-powered static site generator designed for documentation, built on Vite by the Vue/Vite team (Evan You). It provides a fast dev experience, Markdown-based authoring with Vue components, built-in search, and a clean default theme. There's nothing wrong with VitePress itself โ it's a solid, well-maintained tool.
Why it's not our defaultโ
- Vue dependency โ we standardize on React. Adopting VitePress for docs means introducing Vue into the stack, creating a split ecosystem and additional tooling overhead.
- We already have two recommended doc frameworks โ Docusaurus for React-based documentation sites (it powers this Web Hub) and Astro Starlight for zero-JS, Astro-based docs. A third option adds decision fatigue without clear benefit.
- Fewer Aliz developers with Vue experience โ VitePress customization requires Vue knowledge, which limits who can contribute to and maintain the site.
When it makes senseโ
- Client requirement or existing VitePress site โ if the client already runs VitePress or specifically requests it.
- Team already has Vue expertise and the docs site is self-contained โ if the team knows Vue well and the documentation site won't need to share components or infrastructure with React-based projects.
Alternativeโ
- Docusaurus โ React-based, rich plugin ecosystem, powers the Aliz Web Hub.
- Astro Starlight โ zero-JS by default, Astro-based, excellent performance.