Skip to content
📝 Minimalistic Vue-powered static site generator
Branch: master
Clone or download

README.md

logo

Downloads Version npm next version License vuepress channel on Discord

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

Status: alpha

Certain combinations of plugins may not work properly, and things may change or break until we reach beta phase. Do not use in production yet unless you are adventurous.

For 0.x, it's moved to 0.x branch and still maintained, the website is: https://vuepress.vuejs.org.

Install

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

Showcase

Check out Awesome Vuepress to find awesome things related to VuePress 1.x .

Development

Please make sure your version of Node.js is greater than 8.

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.

License

MIT

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.