
Install ¶
yarn add vuepress -D
Documentation ¶
Check out our docs at https://vuepress.vuejs.org/.
Showcase ¶
Contribution ¶
Want to contribute? Check our issues for beginners!
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 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 ¶
<td align="center"><a href="http://ulivz.com"><img src="https://avatars1.githubusercontent.com/u/23133919?v=4" width="100px;" alt="ULIVZ"/><br /><sub><b>ULIVZ</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=ulivz" title="Code">?</a> <a href="https://github.com/vuejs/vuepress/commits?author=ulivz" title="Documentation">?</a></td>
<td align="center"><a href="https://www.franck-abgrall.me/"><img src="https://avatars3.githubusercontent.com/u/9840435?v=4" width="100px;" alt="Franck Abgrall"/><br /><sub><b>Franck Abgrall</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=kefranabg" title="Code">?</a> <a href="#question-kefranabg" title="Answering Questions">?</a></td>
<td align="center"><a href="https://github.com/f3ltron"><img src="https://avatars1.githubusercontent.com/u/11556276?v=4" width="100px;" alt="Giraud Florent"/><br /><sub><b>Giraud Florent</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=f3ltron" title="Code">?</a></td>
<td align="center"><a href="https://billychin.netlify.com/"><img src="https://avatars0.githubusercontent.com/u/38957202?v=4" width="100px;" alt="Billyyyyy3320"/><br /><sub><b>Billyyyyy3320</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=newsbielt703" title="Code">?</a></td>
<td align="center"><a href="http://www.bencodezen.io"><img src="https://avatars0.githubusercontent.com/u/4836334?v=4" width="100px;" alt="Ben Hong"/><br /><sub><b>Ben Hong</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=bencodezen" title="Code">?</a> <a href="#blog-bencodezen" title="Blogposts">?</a></td>
<td align="center"><a href="https://twitter.com/vicbergquist"><img src="https://avatars0.githubusercontent.com/u/25737281?v=4" width="100px;" alt="Victoria Bergquist"/><br /><sub><b>Victoria Bergquist</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=vicbergquist" title="Code">?</a> <a href="#design-vicbergquist" title="Design">?</a></td>
<td align="center"><a href="https://frontstuff.io/"><img src="https://avatars0.githubusercontent.com/u/5370675?v=4" width="100px;" alt="Sarah Dayan"/><br /><sub><b>Sarah Dayan</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=sarahdayan" title="Code">?</a> <a href="https://github.com/vuejs/vuepress/commits?author=sarahdayan" title="Documentation">?</a></td>
<td align="center"><img src="https://avatars0.githubusercontent.com/u/18205362?s=400&v=4" width="100px;" alt="meteorlxy"/><br /><sub><b>meteorlxy</b></sub><br /><a href="https://github.com/vuejs/vuepress/commits?author=meteorlxy" title="Code">?</a></td>
<td align="center"><a href="https://sobolevn.me"><img src="https://avatars1.githubusercontent.com/u/4660275?v=4" width="100px;" alt="Nikita Sobolev"/><br /><sub><b>Nikita Sobolev</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=sobolevn" title="Code">?</a> <a href="https://github.com/vuejs/vuepress/commits?author=sobolevn" title="Documentation">?</a></td>
<td align="center"><a href="https://twitter.com/CodesOfRa"><img src="https://avatars0.githubusercontent.com/u/945186?v=4" width="100px;" alt="Ramona"/><br /><sub><b>Ramona</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=CodesOfRa" title="Code">?</a></td>
<td align="center"><a href="https://fatihacet.com"><img src="https://avatars3.githubusercontent.com/u/712419?v=4" width="100px;" alt="Fatih Acet"/><br /><sub><b>Fatih Acet</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=fatihacet" title="Code">?</a></td>
<td align="center"><a href="http://farcaller.net/"><img src="https://avatars2.githubusercontent.com/u/693?v=4" width="100px;" alt="Vladimir Pouzanov"/><br /><sub><b>Vladimir Pouzanov</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=farcaller" title="Code">?</a></td>
<td align="center"><a href="https://twitter.com/_vinayak_k"><img src="https://avatars2.githubusercontent.com/u/19776877?v=4" width="100px;" alt="Vinayak Kulkarni"/><br /><sub><b>Vinayak Kulkarni</b></sub></a><br /><a href="#plugin-vinayakkulkarni" title="Plugin/utility libraries">?</a> <a href="https://github.com/vuejs/vuepress/commits?author=vinayakkulkarni" title="Code">?</a> <a href="#blog-vinayakkulkarni" title="Blogposts">?</a></td>
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