Gulp plugin to publish to Github pages.
Special thanks to the folks who have contributed to this plugin.git
First you need to be sure you have a
If you don't have one, you can do the following:
git checkout --orphan gh-pagesgit rm -rf .touch README.mdgit add README.mdgit commit -m "Init gh-pages"git push --set-upstream origin gh-pagesgit checkout master
gulp-gh-pages as a development dependency
npm install --save-dev gulp-gh-pages
Then define a
deploy task in your
gulpfile.js (as below) which can be used to push to
gh-pages going forward.
var deploy = ;gulp;
Now, you should be able to call your task by doing
Default: URL for the remote of the current dir (assumes a git repository)
gulp-gh-pages assumes the current working directory is a git repository and uses its remote url. If your
gulpfile.js is not in a git repository, or if you want to push to a different remote url, you can specify it. Ensure you have write access to the repository.
The branch where deploy will by done. Change to "master" for
Default: a temporary folder
Useful to keep a cache of the repo to avoid fresh clone all the time.
Allow you to make a build on the defined branch without pushing it to master. Useful for dry run.