VuePress
vuepress.vuejs.org
- Free plan
- Web
- API
- Self-hosted
What VuePress is
VuePress is a free, MIT-licensed static site generator for documentation, blogs, and other static sites. Authors write Markdown pages that become HTML and are processed as Vue components, allowing templates, components, and dynamic content inside Markdown. Pages are pre-rendered during the build, then the loaded site runs as a single-page application. The default theme is optimized for technical documentation and includes header search, configurable navigation and sidebars, with Algolia Search support. Markdown features include tables of contents, custom containers, line highlighting and numbering, imported code snippets, GitHub Flavored Markdown tables, and strikethrough. VuePress supports Vite and Webpack without extra bundler configuration, plus an official plugin API and community plugins on npm. Locales are configurable, though multilingual behavior depends on the theme. Deployment guidance covers GitHub Pages, GitLab Pages, Firebase, Heroku, Netlify, and Vercel. Setup requires Node.js v20.9.0 or later and a package manager. VuePress v2 is in release-candidate status.
Who it suits
VuePress suits developers and documentation teams comfortable with Markdown, Vue, and Node.js tooling. It is useful for technical documentation, blogs, and other static websites.
Good to know, and what to watch
- Free and MIT licensed
- Vue components can be used in Markdown
- Default theme includes search and sidebars
- Supports Vite and Webpack
- Guides cover several deployment services
- Requires Node.js v20.9.0 or later
- VuePress v2 is release-candidate software
- Multilingual support varies by theme
The verdict
VuePress combines Markdown authoring with Vue components, static rendering, and a documentation-focused theme. Its plugin and deployment options are broad, but the current release-candidate status may require attention to configuration changes.
What the maker publishes
- Audience
- The project began to support Vue.js documentation and its sub-projects, and the documentation says users also use it for documentation, blogs, and other static sites. source
- Bundlers
- VuePress supports Vite and Webpack, and its documentation says no extra configuration is required to use either bundler. source
- Bundlers
- VuePress supports Vite and Webpack, which users install separately when setting up the project. source
- Deployment
- The deployment guide includes instructions for GitHub Pages, GitLab Pages, Firebase, Heroku, Netlify, and Vercel. source
- Free plan
- Yes source
- Google Analytics
- The official plugin documentation gives Google Analytics as an integration using the @vuepress/plugin-google-analytics plugin. source
- Install requirements
- The current getting-started guide lists Node.js v20.9.0 or later and a package manager such as pnpm, yarn, or npm as prerequisites. source
- Internationalization
- VuePress supports site locales through configuration, while theme-specific multilingual support varies by theme. source
- License
- The official site describes VuePress as MIT licensed. source
- Markdown
- Markdown pages support built-in extensions including tables of contents, custom containers, line highlighting, line numbers, and imported code snippets. source
- Markdown features
- Built-in Markdown extensions include GitHub Flavored Markdown tables and strikethrough, and users can configure or add markdown-it extensions. source
- Plugins
- VuePress provides an official plugin API and official plugins, and community plugins are published on npm. source
- Plugins
- VuePress has a plugin API, with official plugins including search, PWA, Google Analytics, and last-updated support; some plugins must be installed manually. source
- Product
- VuePress is a Vue-powered static site generator with a default theme optimized for technical documentation. source
- Purpose
- VuePress is a Markdown-centered static site generator for documentation, blogs, and other static sites. source
- Release status
- The getting-started guide says VuePress v2 is in release-candidate status and that its configuration and API may have minor breaking changes between releases. source
- Rendering
- It pre-renders each page as static HTML, then uses Vue to turn the site into a single-page application after loading. source
- Requirements
- The getting-started guide lists Node.js v20.9.0 or later and a package manager such as pnpm, Yarn, or npm as prerequisites. source
- Search and navigation
- The default theme includes header-based search, customizable navigation and sidebars, and supports Algolia Search. source
- Static output
- VuePress renders a server-rendered version of the site into HTML during the build and runs it as a single-page application after loading. source
- Themes
- VuePress includes a default theme and supports community themes and custom themes built with Vue. source
- Version status
- The getting-started guide says VuePress v2 is in release-candidate stage and warns its configuration and API may have minor breaking changes. source
- Vue components
- VuePress lets authors use Vue templates and components inside Markdown files. source
- Vue in Markdown
- Markdown pages are compiled into HTML and processed as Vue components, so authors can use Vue components and dynamic content in Markdown. source
Checked against the maker's pages on 8 Oct 2026.