search

bitovi / documentcss

A documentation/guide portal for the Live Style Guide feature of DocumentJS
https://documentcss.com/
MIT License
72 stars 7 forks source link

Remove generated files from repo, Add deploy plugin #51

Open leoj3n opened 7 years ago

leoj3n commented 7 years ago

Use like:

grunt

grunt buildcontrol:pages

Despite having not having updated the docs (yet), this is functional and ready to go.

I think the only necessary change will be in Gruntfile.js:

The value of buildcontrol.pages.options.remote should be changed from git@github.com:leoj3n/documentcss.git to git@github.com:bitovi/documentcss.git so that when a maintainer with push access to https://github.com/bitovi/documentcss runs grunt buildcontrol:pages, the gh-pages branch is updated with the generated files.

Contributors will still be able to see their changes locally with grunt just as before.

leoj3n commented 7 years ago

To see the results of these changes check out:

https://github.com/leoj3n/documentcss/tree/deploy-to-gh-pages

Here is what is generated by the deploy command:

https://github.com/leoj3n/documentcss/tree/gh-pages

(site is live at https://leoj3n.github.io/documentcss/)

So, you can try these changes out on your own fork, just update

buildcontrol.pages.options.remote (in Gruntfile.js)

to point to git@github.com:YOURNAME/documentcss.git before running:

grunt && grunt buildcontrol:pages