Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @mattdesl/ghpages with all npm packages installed. Try it out:

@mattdesl/ghpages lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("@mattdesl/ghpages/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@mattdesl/ghpages v1.2.0

quick script which deploys to gh-pages branch

@mattdesl/ghpages

experimental

A small, personalized shell script which switches to gh-pages branch, runs npm run build, commits and pushes the new changes, and then switches back to your previous branch.

Install

npm install @mattdesl/ghpages -g

Usage

cd to your module directory. Make sure it has a build script in package.json:

{
  "scripts": {
    "build": "browserify index.js > bundle.js"
  }
}

Now, with a clean git working directory, and on the default (i.e. master) branch, just run the following to push to gh-pages:

ghpages

This will check out gh-pages branch (creating it if necessary), merge master into it, npm run build, then commit and push the new build and switch back to master.

In some cases, you may need to modify the .gitignore of your gh-pages branch to ensure that bundle.js is pushed to git. You can pass the -i flag which will also remove bundle.js from your current directory's .gitignore before committing.

ghpages -i

License

MIT, see LICENSE.md for details.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free