$ git clone <this repo> <target folder>
$ npm install
$ npm install -g vuepress
- Run the project
npm run docs:dev
- add folders and markdown
.md
files, you can create vuejs components as theFoo.vue
example in the.vuepress
the insert it anywhere with - menu are congigured in
config.js
- when happy with your changes
$ git add -A
(or$ git add --all .
)$ git commit -m"describe your change"
$ git pull origin master
you might need to resolve conflicts then$ git push origin master
From here everything is handled for you. It takes about 4 minutes (time to build and go through the automated process) and changes will be online.
if you want to do a lot of changes you could do a branch:
$ git checkout -b <name of the branch>
- work and do your commits
$ git pull origin master
solve potential conflicts$ git checkout master
$ git merge <name of the branch>
$ git push origin master