Gulp-gh-pages-cname NPM

This is a fork

The current plugin maintainer doesn't want to add CNAME support. So I forked it, added support, and NPM published :)

gulp-gh-pages

gulp plugin to publish contents to Github pages

Installation

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

Usage

Define a deploy task in your gulpfile.js (as below) which can be used to push to gh-pages going forward.

var gulp   = require('gulp');
var ghPages = require('gulp-gh-pages');

gulp.task('deploy', function() {
  return gulp.src('./dist/**/*')
    .pipe(ghPages());
});

Now, you should be able to call your task by doing:

gulp deploy

API

var ghPages = require('gulp-gh-pages');

ghPages(options)

options: Object Return: Object (stream.Transform)

options.remoteUrl

Type: String Default: URL for the remote of the current dir (assumes a git repository)

By default 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.