Skip to content

ulivz/template-vuepress

Repository files navigation

sherry-vuepress

Scaffold out a VuePress project.

NPM version NPM downloads Build Status donate

preview

Features

Greenkeeper badge

  • Support for use in new or exisitng projects
  • Global Sidebar config generation out of box
  • NPM scripts injection for exisitng projects
  • Friendly user guide
  • Github Pages release integration

Usage

Install Sherry first.

yarn global add sherry
# or
npm i -g sherry

It's recommended to execute following instructions at your project dir instead of project's father directory. since we will determine whether it's a new or exisitng project by checking files in current working directory.

From npm

sherry vuepress # using in a exisiting projects
sherry -u vuepress # fetch the latest version before the start.

# or
sherry vuepress my-project 

From git

sherry ulivz/sherry-vuepress # using in a exisiting projects
# or
sherry ulivz/sherry-vuepress my-project

License

MIT © ULIVZ