Publishing to Github Pages' User or Organization Pages

Proteus Gulp is set up to publish to Github Pages' Project Pages right out of the box. Setting it up to use User or Organization Pages is easy too, just follow the instructions below:

• Read Github's documentation on the differences between the two types of pages
• We're using an npm package called gulp-gh-pages to make deploying to Github Pages as easy as possible. We want to push to the master branch, so we just need to add one line to our configuration in Gulpfile.js:

gulp.task('deploy', function () {
  return gulp.src("./build/**/*")
    .pipe(deploy({
      branch: "master"
    }));
});

• Make sure your repo on Github also follows the convention of username.github.io.
• If you are wanting to use a custom domain, make sure to follow Github's documentation for that too. You will want to place the CNAME file in the root of the /source directory to make sure it ends up in the right place.