Skip to content

Instantly share code, notes, and snippets.

View zed-wong's full-sized avatar
🕌

Zed Wong zed-wong

🕌
View GitHub Profile
@zed-wong
zed-wong / gh-pages-deploy.md
Created April 29, 2023 01:12 — forked from cobyism/gh-pages-deploy.md
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 dist directory from the project’s .gitignore file (it’s ignored by default by Yeoman).