usmu-github-pages

Circle CI Dependency Status Code Climate

Source: https://github.com/usmu/usmu-github-pages Author: Matthew Scharley
Contributors: See contributors on GitHub
Bugs/Support: Github Issues
Copyright: 2014
License: MIT license
Status: Active

Synopsis

Allows you to deploy your Usmu website to the Github Pages service or another git-based service.

Installation

$ gem install usmu-github-pages

OR

$ echo 'gem "usmu-github-pages"' >> Gemfile
$ bundle install

Usmu will automatically detect any plugins available and automatically make them available.

Configuration

$ usmu gh-pages init

This plugin also supports a few keys in usmu.yml:

plugins:
  github-pages:
    # The remote to deploy to. Change this if github is not your origin
    # remote.
    remote: origin
    # The branch to deploy to. This should get correctly configured
    # automatically in all cases involving Github but is provided just in
    # case you need to change it or you are using another git-based host.
    branch: gh-pages

Usage

$ usmu gh-pages deploy