# vuepress

> Minimalistic doc generator with Vue component based layout system

Latest version **1.9.10** (published 2023-08-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install vuepress
pnpm add vuepress
yarn add vuepress
bun add vuepress
```

Provides the command `vuepress`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities; popular repo.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.9.10 |
| Published | 2023-08-14 |
| First published | 2018-04-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8.6 |
| Dependencies | 7 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 22732 |
| Author | Evan You |
| Maintainers | ulivz, yyx990803, newsbielt703, bencodezen, kefranabg, meteorlxy |
| Keywords | documentation, generator, vue |

## Links

- npm: https://www.npmjs.com/package/vuepress
- Repository: https://github.com/vuejs/vuepress
- Homepage: https://github.com/vuejs/vuepress#readme
- Issues: https://github.com/vuejs/vuepress/issues
- npm.io page: https://npm.io/package/vuepress

## Dependencies (7)

- [cac](https://npm.io/package/cac.md) ^6.5.6
- [envinfo](https://npm.io/package/envinfo.md) ^7.2.0
- [@vuepress/core](https://npm.io/package/@vuepress/core.md) 1.9.10
- [@vuepress/types](https://npm.io/package/@vuepress/types.md) 1.9.10
- [update-notifier](https://npm.io/package/update-notifier.md) ^4.0.0
- [@vuepress/theme-default](https://npm.io/package/@vuepress/theme-default.md) 1.9.10
- [opencollective-postinstall](https://npm.io/package/opencollective-postinstall.md) ^2.0.2

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.9.10 (latest) — 2023-08-14
- 2.0.0-rc.31 (next) — 2026-07-24
- 2.0.0-rc.27 (next-beta) — 2026-03-10
- 1.9.8 (latest-v1) — 2023-01-06
- 2.0.0-rc.30 — 2026-05-14
- 2.0.0-rc.29 — 2026-05-08
- 2.0.0-rc.28 — 2026-04-01
- 2.0.0-rc.26 — 2025-10-14
- 2.0.0-rc.25 — 2025-08-26
- 2.0.0-rc.24 — 2025-06-30
- 2.0.0-rc.23 — 2025-05-08
- 2.0.0-rc.22 — 2025-04-28
- 2.0.0-rc.21 — 2025-04-12
- 2.0.0-rc.20 — 2025-02-23
- 2.0.0-rc.19 — 2024-12-11
- … 245 more at https://npm.io/package/vuepress/versions

## README

<p align="center">
  <a href="https://vuepress.vuejs.org/" target="_blank" rel="noopener noreferrer">
    <img width="180" src="https://raw.githubusercontent.com/vuejs/vuepress/master/packages/docs/docs/.vuepress/public/hero.png" alt="logo">
  </a>
</p>

<p align="center">
  <a href="https://npmcharts.com/compare/vuepress?minimal=true"><a href="https://opencollective.com/vuepress" alt="Financial Contributors on Open Collective"><img src="https://opencollective.com/vuepress/all/badge.svg?label=financial+contributors" /></a> <img src="https://img.shields.io/npm/dm/vuepress.svg" alt="Downloads"></a>
  <a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/v/vuepress.svg" alt="Version"></a>
  <a href="https://github.com/vuejs/vuepress/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/vuepress.svg" alt="License"></a>
  <a href="https://discordapp.com/invite/HBherRA"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg" alt="VuePress channel on Discord"></a>
</p>

# VuePress

:memo: Minimalistic Vue-powered static site generator

## Installation

Use the package manager [yarn](https://yarnpkg.com/) to install VuePress as a dev dependency.

```bash
yarn add vuepress -D
```

## Documentation

The docs are available at <https://vuepress.vuejs.org>

## Contributing

Want to contribute? Check our [issues for beginners](https://github.com/vuejs/vuepress/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)!

```bash
yarn # Install and link dependencies for this monorepo
yarn dev  # serves VuePress' own docs with itself
yarn test # make sure your code change pass the test
```

If you don't have a local checkout, you can also open [VuePress in Gitpod](https://gitpod.io/#https://github.com/vuejs/vuepress/blob/master/packages/docs/docs/README.md), a free online IDE for GitHub.

If you intend to make `"substantial"` changes to VuePress or its documentation, please checkout [VuePress RFCs](./rfcs/README.md).

If you have a VuePress-related project/component/tool, add it with a pull request to [this curated list](https://github.com/ulivz/awesome-vuepress)!

## License

[MIT](https://github.com/vuejs/vuepress/blob/master/LICENSE)

---
_Source: https://npm.io/package/vuepress · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._