Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A volo command for deploying a directory to GitHub Pages

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 .npmignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 index.js
README.md

volo-ghdeploy

A volo command for deploying a directory to GitHub Pages.

Installation

Install this command via npm into a project's local node_modules directory:

npm install volo-ghdeploy

Then, in the volofile for the project, create a volo command name that does a require() for this command, and pass it the buildDir and pagesDir to use:

//in the volofile
module.exports = {
    //Creates a local project command called ghdeploy
    ghdeploy: require('volo-ghdeploy')('www-built', 'www-ghdeploy')
}

Usage

While in the project directory, just type:

volo ghdeploy

To deploy the code to github. You may be prompted the first time you run it for information on how to connect to github and what repo to use.

ghdeploy will create the repo if it does not exist.

License

MIT and new BSD.

Something went wrong with that request. Please try again.