Skip to content
Scaffolding out a VuePress docs, blog, repro repo or other interesting things
Branch: master
Clone or download
cfjedimaster and ulivz feat: update instructions (#3)
* Update

Add note about loading dependencies.

* chore: update instructions
Latest commit 26d7643 Jun 13, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: add funding Jun 6, 2019
lib feat: bump vuepress and other official packages to 1.x Jun 12, 2019
.editorconfig feat: init Jun 4, 2019
.gitattributes feat: init Jun 4, 2019
.gitignore feat: init Jun 4, 2019
LICENSE feat: init Jun 4, 2019
cli.js feat: init Jun 4, 2019
index.js feat: init Jun 4, 2019
package.json 0.0.11 Jun 12, 2019


Scaffolding a VuePress project

NPM version NPM downloads


Note that you need to initialize this instruction in an empty directory.

$ yarn create vuepress [appName]

Please be sure to cd [appName] and run yarn to install dependencies.


  • docs - Create a documentation project with VuePress.
  • blog - Create a blog project with VuePress.


  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Prior Art

create-vuepress will not be born without inspiration from these projects:

  • create-umi (Direct reuse of scaffolding functions of the library.)


create-vuepress © ULIVZ, Released under the MIT License.
Authored and maintained by ULIVZ with help from contributors (list). · GitHub @ULIVZ · Twitter @_ulivz

You can’t perform that action at this time.