https://github.com/ulivz/template-vuepress

Scaffold out a VuePress project.
https://github.com/ulivz/template-vuepress

Last synced: 3 months ago
JSON representation

Scaffold out a VuePress project.

• Host: GitHub
• URL: https://github.com/ulivz/template-vuepress
• Owner: ulivz
• License: mit
• Created: 2018-06-30T02:58:10.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-06-09T11:27:35.000Z (over 4 years ago)
• Last Synced: 2025-06-16T01:20:38.025Z (4 months ago)
• Language: JavaScript
• Size: 942 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
sherry-vuepress




  Scaffold out a VuePress project.





   





  



## Features

[![Greenkeeper badge](https://badges.greenkeeper.io/ulivz/template-vuepress.svg)](https://greenkeeper.io/)

- Support for use in new or exisitng projects

- Global [Sidebar](https://vuepress.vuejs.org/default-theme-config/#sidebar) config generation out of box

- NPM scripts injection for exisitng projects

- Friendly user guide

- [Github Pages](https://vuepress.vuejs.org/guide/deploy.html#github-pages) release integration

## Usage

Install Sherry first.

``` bash

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

``` bash

sherry vuepress # using in a exisiting projects

sherry -u vuepress # fetch the latest version before the start.

# or

sherry vuepress my-project 

```

### From git

``` bash

sherry ulivz/sherry-vuepress # using in a exisiting projects

# or

sherry ulivz/sherry-vuepress my-project

```

## License

MIT © [ULIVZ](https://github.com/ulivz)