Skip to content

Instantly share code, notes, and snippets.

@mauriciord
Forked from cobyism/gh-pages-deploy.md
Last active May 29, 2017 19:45
Show Gist options
  • Save mauriciord/6da4dd19100a151ef2a236fad5ed3125 to your computer and use it in GitHub Desktop.
Save mauriciord/6da4dd19100a151ef2a236fad5ed3125 to your computer and use it in GitHub Desktop.
Deploy to `gh-pages` from a `dist` folder on the master branch. Useful for use with [yeoman](http://yeoman.io).

Deploying a subfolder to GitHub Pages

Sometimes you want to have a subdirectory on the master branch be the root directory of a repository’s gh-pages branch. This is useful for things like sites developed with Yeoman, or if you have a Jekyll site contained in the master branch alongside the rest of your code.

For the sake of this example, let’s pretend the subfolder containing your site is named dist.

Step 1

Remove the public directory from the project’s .gitignore file (it’s ignored by default by Yeoman).

Step 2

Make sure git knows about your subtree (the subfolder with your site).

git add public && git commit -m "envio ao github pages"

Step 3

Use subtree push to send it to the gh-pages branch on GitHub.

git subtree push --prefix public origin gh-pages

Boom. If your folder isn’t called dist, then you’ll need to change that in each of the commands above.


If you do this on a regular basis, you could also create a script containing the following somewhere in your path:

#!/bin/sh
if [ -z "$1" ]
then
  echo "Which folder do you want to deploy to GitHub Pages?"
  exit 1
fi
git subtree push --prefix $1 origin gh-pages

Which lets you type commands like:

git gh-deploy path/to/your/site
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment