gulp-gh-pages

gulp-gh-pages

Gulp plugin to publish to Github pages.

Usage

First, install gulp-gh-pages as a development dependency

npm install --save-dev gulp-gh-pages

If your repository does not have a gh-pages branch, it is advised that you create one first. I used git subtree push --prefix <dist folder> origin 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 = require("gulp-gh-pages");

gulp.task('deploy', function () {
	gulp.src("./dist/**/*")
		.pipe(deploy(gitRemoteUrl, remote));
});

API

deploy(gitRemoteUrl, remote)

Either define options.templatePath or options.template. If both are given, options.templatePath is used.

gitRemoteUrl

Type: String Default: undefined Required: true

Your git remote url. Ensure you have write access to the repository.

remote

Type: String Default: origin Required: true

Git remote.

License

MIT License