Open-source project
vuejs/vitepress avatar
vuejs/vitepress

vuejs/vitepress: three alphas and no stable 2, plus a build that packs the tarball before publishing

Vite & Vue powered static site generator.

18,494 stars2,753 forksTypeScriptMIT

At a glance

What is it?
VitePress is a Vue static site generator built on Vite, and it is mid major version: the three newest tags are all alphas of the same number, one to two months apart. What is more instructive is the build. It bundles, type checks three configurations with two different compilers, generates editor metadata, and then packs the tarball and runs two validation tools against it before anything is published.
Who is it for?
Use VitePress if you are writing documentation in Vue components and want a static site generator that ships its own theme, its own types and a project template, because that bundle is what you would otherwise assemble. Do not start a new project on the 2.0 line expecting stability, because the visible tags are all alphas and the badge row points at a pre-release channel and a hosted nightly rather than a stable one.
Can I use it commercially?
Yes. MIT is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
Is it still maintained?
Yes. The repository last received commits 3 days ago.
What is it written in?
Mainly TypeScript, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • vuejs/vitepress18,494 ★ · +154
Star history
Repository2026-09-212026-11-15
vuejs/vitepress18.3k18.5k

154 Stars in the last 55 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

The three newest tags are alpha releases

Read the release list as a pattern rather than a list. The three most recent tags are the same version with three different alpha suffixes: one in early August, one in early September, one in late October.

There is no stable 2.0 in the visible list. The manifest carries the same alpha number as the newest tag, which is the convention for a project whose trunk is a pre-release and whose stable line is a previous major.

The badge row confirms three channels rather than one. There is a test status badge, a registry badge pointing at the pre-release channel for the package, and a link to a hosted nightly build. So a reader arriving at the repository sees a build status, a canary and a nightly, and none of the three is a stable release.

The practical consequence is that a version claim needs a channel. If you write that you are on the latest version, that is true of the candidates and false of any stable line, and the registry is where you find out which one a given install came from.

The build packs the tarball and checks the package, not just the code

The build script is a chain of five steps, and the last two are about the published artefact rather than the source.

It runs the bundler, then a type check, then a script that generates the editor types file, then a build check. That build check is two tools: one that lints a package's own metadata the way a registry would, and one that checks type resolution by actually packing the tarball and inspecting it, under a profile that only allows the module system this package is written in.

So the thing that gets validated is the file people install, built fresh from a pack, not the working tree. That catches the class of problem where a declaration file is in the source directory and absent from the published file list, or where a subpath resolves in development and not after packing.

It also explains two fields in the manifest that would otherwise look odd. The editor types field points into the build output rather than at a checked-in file, because it is generated during the build; and the published file list contains three declaration files that sit at the repository root as hand-written shims, which is why they are listed individually rather than swept up by a directory.

The test command is a regular expression over five separate projects

The test script is a single pnpm invocation whose argument is a pattern, and the pattern is matched against script names.

The expression selects five projects, and the reporter is an append-only one with aggregated output, which is what you want when five processes write interleaved logs. The five are the type tests, the unit tests, the end to end tests, a project called init, and a project called base.

Two things follow. One is that the set is closed: the expression is anchored and lists its five names, so a new test script is not picked up without editing the pattern. The other is that one of the five is the package's own initialisation, and the corresponding type test runs a compiler over a directory with that name, so getting the tool to start cleanly is a tested property rather than an assumption.

For a package that is a command line tool as much as a library, that is the right set of boundaries, and the fact that the type tests are one of the five rather than an afterthought is the notable part.

Type checking runs three different compilers over three configurations

There are five TypeScript configuration files at the root, and the type check script uses three of them with two different compilers.

A plain compiler runs against the shared configuration, then a Vue-aware compiler runs against the client configuration, then the plain compiler runs again against the node configuration. The order is not arbitrary: the shared code is checked first, then the single file component code, then the server side.

The type test script repeats the same shape across four test project directories, again alternating the two compilers, which is what you would expect for a project whose client is Vue and whose server is not.

The consequence is practical rather than theoretical. A type error in a single file component is reported by a different tool from every other type error in the repository, with its own output format and its own idea of what is wrong. That is correct, because the two languages of files are different, and it does mean that a surprising type error is worth checking against the tool that produced it before assuming the types are wrong.

Three declaration shims at the root are the public type surface

The exports map has six entries and three of them are the same shape: a hand-written declaration file at the package root, and a runtime target inside the build.

The client entry points at a root declaration file and at the built client. The theme entry points at a root declaration file and at the built default theme. The theme-without-fonts entry points at its own root declaration file and at the same theme build, a differently named file, which is the variant that omits bundled fonts.

So a consumer's type information for three of the six entry points comes from files that live in the repository root rather than from the build output, and all three are listed individually in the published files. That is deliberate, and it is the usual arrangement when the runtime target is a build artefact whose shape the package author wants to describe by hand.

The published file list ships a template and names a directory that is not in the tree

The published file list has nine entries and two of them are worth reading closely.

One is a template directory. That is the project scaffold, and shipping it is how a create command has something to copy, so the package is carrying the starting point for a new site rather than only the code that builds one.

The other is a directory named lib, which is not at the repository root. The root has a source directory, a scripts directory, a bin directory and a types directory, and no lib. So either the bundler creates that directory as a build output, or the entry is residue from an earlier layout.

There is also a passthrough export for the dist directory and one for the package manifest, so a consumer can reach into the build output by path. That is useful when you need a file the exports map does not name, and it removes the packaging boundary that would otherwise stop you.

Search, playground, previews and browser testing are all somebody else's service

The README ends with a table of five companies, and the descriptions are specific enough to show that the project's own site is assembled from vendor services rather than being self contained.

The company behind Vite is listed as a long time sponsor, and the note says the generator is built on that ecosystem of tooling. A web container company powers the playground and provides instant preview releases for pull requests and commits. A search company powers the documentation search and is described as a long time partner in building and maintaining that integration. A device testing company provides the cross browser and real device infrastructure used to check the generator works across browsers. A hosting platform powers the website deployments on its open source plan and provides deploy previews for pull requests.

So four capabilities of the official site, search, the playground, previews and the browser matrix, each require an account with somebody else. That is normal and it is also a migration list if you ever fork the site.

The root has a third party notices file and a hosting configuration file, which is the documentary trace of those dependencies, and the notices file ships inside the published package.

Editorial conclusion

Use VitePress if you are writing documentation in Vue components and want a static site generator that ships its own theme, its own types and a project template, because that bundle is what you would otherwise assemble. Do not start a new project on the 2.0 line expecting stability, because the visible tags are all alphas and the badge row points at a pre-release channel and a hosted nightly rather than a stable one. Check three things before you pin: which channel you are on, since the newest tag is an alpha; that your editor understands the metadata, because the build generates an editor types file and ships three declaration shims at the package root; and which subpath you import, because the theme subpath resolves to the default theme build and there is a separate entry for the variant without fonts. The license is MIT with a copyright line dating the project from 2019, the repository is not archived, and the last push was 2026-10-29.

Frequently asked questions

What is VitePress?

It is a Vue-powered static site generator built on top of Vite, which the README describes as a spiritual successor to VuePress. The package ships its own default theme, its own type definitions, a command line entry point, a project template, and a theme variant without bundled fonts. Its own documentation site uses hosted search, a hosted playground, hosted cross-browser testing and hosted preview deployments.

Which is better, VuePress or VitePress?

The README makes no comparison between the two. It says VitePress is a spiritual successor to VuePress and is built on top of Vite, and the copyright line runs from 2019 to the present.

is vitepress the same as vite

No. Vite is the build tool it is built on, and the README names the company behind Vite as a long-time sponsor whose ecosystem of tooling the generator sits on. The package itself is the static site generator, and the build step in its own repository uses a separate bundler for the library build.

is vitepress dead

The repository is not archived and the last push was 2026-10-29. The three newest releases are alphas of one version, one to two months apart, so the project is active and mid major version, and the badge row points at a pre-release channel and a hosted nightly rather than a stable release.

What are some other tools similar to VitePress?

The README names no alternative tools. It names what the project is built on, that is Vite and Vue, who sponsors the tooling, and which hosted services its own site depends on for search, playground previews, cross-browser testing and deployment previews.

Official sources

  1. License: MIT
  2. Project website
  3. README
  4. Releases
  5. vuejs/vitepress on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/vuejs-vitepress.svg)](https://hysenlabs.com/projects/vuejs-vitepress)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/vuejs-vitepress.svg)](https://hysenlabs.com/projects/vuejs-vitepress)

Was this useful?