publish-github-pages v0.1.2

publish-github-pages

Small tool to make publishing to gh-pages easier.

Installation

npm i -g publish-github-pages

Configuration

Create a file .gh-pages.json in the root folder. It should have the following structure:

{
    "dir": "./path/to/docs",
    "remote": "git@github.com:torbenm/publish-github-pages.git",
    "branch": "gh-pages",
    // any script for creating the docs here
    "build": "touch ${path}/index.html", 
    // ${tags-verbose} will take the value of git describe origin/master --tags
    "commit": "Documentation update ${tags-verbose}" 
}

Running it

Please make sure you have the correct branch in your github repository before. This is currently mandatory, but will likely change in the future.

gh-pages publish