## Install ### Package ```bash yarn add vuepress -D ``` ### Generator ```bash # Creates a scaffolded docs site yarn create vuepress-site ``` For more information, see [create-vuepress-site](https://github.com/vuepressjs/create-vuepress-site). ## Documentation Check out our docs at https://vuepress.vuejs.org/. ## Showcase - [Awesome VuePress](https://github.com/vuepressjs/awesome-vuepress) - [vuepress.tools](https://z3by.github.io/vuepress-tools/) (By [Ahmad Mostafa](https://ahmadmostafa.com)) ## Contribution Want to contribute? Check our [Contributing Guide](.github/CONTRIBUTING.md) and [issues for beginners](https://github.com/vuejs/vuepress/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)! ```bash yarn install # install all dependencies 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/vuepressjs/awesome-vuepress)! ## Contributors ### Creator / Lead

Evan You 💻

ULIVZ 💻 📖

### Active Core Team

Billyyyyy3320 💻

Ben Hong 💻 📖 💬

meteorlxy 💻

Ramona 💻 📖

Franck Abgrall 💻 💬

### Core Team Emeriti Here we honor some no-longer-active core team members who have made valuable contributions in the past.

Giraud Florent 💻

Sarah Dayan 💻 📖

Vinayak Kulkarni 🔌 💻 📝

Victoria Bergquist 💻 🎨

Nikita Sobolev 💻 📖

Fatih Acet 💻

Vladimir Pouzanov 💻

### Code Contributors This project exists thanks to all the people who contribute. [[Contribute](.github/CONTRIBUTING.md)]. ### Financial Contributors Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/vuepress/contribute)] #### Individuals #### Organizations Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/vuepress/contribute)] ## License [MIT](https://github.com/vuejs/vuepress/blob/master/LICENSE)