Skip to content
Get packs

Guide · Open source

How to use VitePress: install, write Markdown and build a docs site

Updated · written with AI from the project's own documentation and checked against our catalogue data

VitePress is a static site generator that turns Markdown files into a fast, ready-to-publish website, mainly for documentation. It is built on Vite and Vue, and its README describes it as a spiritual successor to VuePress. This guide explains what you need before starting, how the project is set up, and where to find the detailed setup steps so you can build a documentation site from your own Markdown files.

VitePressvuejs/vitepress · ★ 18.5k · MIT

Quick start

  1. 1Check Node.js. Confirm Node.js is installed on your computer, since it is the prerequisite listed in the source.
  2. 2Open the official docs. Go to vitepress.dev and follow the setup and usage guide, because the README defers to it.
  3. 3Install with a package manager. Use a package manager to install VitePress, as the official setup instructions describe.
  4. 4Write your content in Markdown. Create your pages as Markdown files, which VitePress converts into website pages.
  5. 5Build the static site. Generate the static pages so you have a ready-to-publish website.
  6. 6Publish the output. Host the generated static files on any static host, since the output is plain pages rather than a database-driven app.

What VitePress is and who it suits

VitePress is a Vue-powered static site generator built on top of Vite. Its main use case is documentation for software projects. You write content in Markdown, and VitePress generates static pages you can publish.

It fits developers who want a documentation site for a project, and teams that already use Vue or Vite and want a familiar toolchain. It is also a good match for people who prefer writing in Markdown rather than using a CMS.

  • Good fit: documentation sites for software projects
  • Good fit: teams already using Vue or Vite
  • Good fit: writers who prefer Markdown over a CMS
  • Not a fit: point-and-click website builders, since it requires code and the command line
  • Not a fit: dynamic, database-driven sites, because VitePress generates static pages

Prerequisites: what you need installed

The source lists Node.js as the prerequisite. VitePress is installed with a package manager, so you will also need to be comfortable running commands in a terminal.

The README is short and does not list every setup detail. For the install and usage steps, use the official documentation at vitepress.dev.

  • Node.js
  • A terminal to run commands
  • A package manager (the install method VitePress uses)

Get the VitePress source code

The README gives a clone command for the repository. This is useful if you want to read the source code or contribute to the project. For building your own documentation site, follow the setup guide at vitepress.dev.

The README also links to a CHANGELOG for release details and a Contributing Guide for anyone submitting a pull request.

git clone https://github.com/vuejs/vitepress.git

Find the setup and usage details

The README points to the official documentation for setup and usage. Visit vitepress.dev for the current instructions, since the README itself does not walk through creating a site.

The project also links to a chat community on Discord for questions, and to nightly releases for testing unreleased builds.

  • Official docs: vitepress.dev
  • Changelog: the CHANGELOG file in the GitHub repository
  • Contributing: the Contributing Guide in the repository
  • Chat: the Vue community Discord, linked from the README

Understand the licence and support

VitePress is released under the MIT licence, which is stated in the README. The README also credits sponsors, including Algolia, which powers DocSearch for VitePress, and Netlify, which hosts the project website and provides deploy previews for pull requests.

Because the licence is MIT, you can read the licence file in the repository to confirm the terms before using it in your project.

  • Licence: MIT
  • Search integration: DocSearch, powered by Algolia, per the README

What people use it for

  • A documentation site for an open-source software project
  • A project guide written in Markdown by a Vue or Vite team
  • A static reference site that does not need a database or user accounts

Frequently asked questions

Is VitePress free to use?

VitePress is released under the MIT licence, as stated in its README. You can read the licence file in the repository to confirm the terms.

What do I need to install VitePress?

The source lists Node.js as the prerequisite. VitePress is installed with a package manager, and the official docs at vitepress.dev describe the setup steps.

Is VitePress a successor to VuePress?

Yes. The README describes VitePress as a spiritual successor to VuePress. It is built on Vite and Vue.

Can I use VitePress without coding?

Not easily. VitePress requires working with code and the command line, so it is not a point-and-click website builder.

Can VitePress build a database-driven website?

No. VitePress generates static pages, so it is not suited to dynamic, database-driven sites.

Where can I get help with VitePress?

The README links to the official docs at vitepress.dev, a Discord chat community, and the CHANGELOG for release details.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

VitePress suits developers who want a fast Markdown-based documentation site, especially teams already using Vue or Vite. If you need a point-and-click builder or a dynamic site with a database, pick a different tool. Comparable projects named in the source include VuePress, Docusaurus, MkDocs and Astro.

Install options & downloads