Install

yarn add vuepress -D

Documentation

Check out our docs at https://vuepress.vuejs.org/.

Showcase

• Awesome VuePress
• vuepress.gallery (by @vicbergquist)
• vuepress.tools (By Ahmad Mostafa)

Contribution

Want to contribute? Check our Contributing Guide and issues for beginners!

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, a free online IDE for GitHub.

If you intend to make "substantial" changes to VuePress or its documentation, please checkout VuePress RFCs.

If you have a VuePress-related project/component/tool, add it with a pull request to this curated list!

Contributors

Core Team

Evan You 💻	ULIVZ 💻 📖	Franck Abgrall 💻 💬	Giraud Florent 💻	Billyyyyy3320 💻	Ben Hong 💻 📝	Victoria Bergquist 💻 🎨
Sarah Dayan 💻 📖	meteorlxy 💻	Nikita Sobolev 💻 📖	Ramona 💻	Fatih Acet 💻	Vladimir Pouzanov 💻	Vinayak Kulkarni 🔌 💻 📝

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

MIT