<p align="center">
  <a href="https://vuepress.vuejs.org/" target="_blank">
    <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"><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://www.npmjs.com/package/vuepress"><img src="https://badgen.net/npm/v/vuepress/next" alt="npm next version"></a>
  <a href="https://www.npmjs.com/package/vuepress"><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>

<h2 align="center">Supporting VuePress</h2>

Maintaining and developing new features to VuePress takes a considerable amount of time (if you know that Gastby's team is a company), and I am currently exploring the possibility of working on VuePress fulltime.

- [Sponsor ULIVZ on Patreon](https://www.patreon.com/ulivz)
- [Sponsor Vue.js](https://vuejs.org/support-vuejs)

> "VuePress is much more than that." —— ULIVZ

## Install

```bash
yarn add vuepress -D       # Install 0.x
yarn add vuepress@next -D  # Install 1.x.
```

## Showcase

- [Awesome Vuepress](https://github.com/ulivz/awesome-vuepress)
- [vuepress.gallery](https://vuepress.gallery) (by [@vicbergquist](https://twitter.com/vicbergquist))

## Documentation

This is the branch for `VuePress 1.x` and docs are available at https://v1.vuepress.vuejs.org.

## Contribution

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

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)!

Thank you to all the people who already contributed to VuePress!

![contributors](https://opencollective.com/vuepress/contributors.svg?width=890)

## License

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