azurecloudmonk / vuepress Goto Github PK

Supporting VuePress

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
• Sponsor Vue.js

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

Install

yarn add vuepress -D

Showcase

• Awesome Vuepress
• vuepress.gallery (by @vicbergquist)

Documentation

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

Contribution

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.

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

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

License

MIT