gh-pages

Deploy dist folder to gh-pages

$ npx gh-pages -d [dist]

$ npx gh-pages -d [dist] -m "[Deploy to GitHub Pages]"

$ npx gh-pages -d [dist] -b [docs]

$ npx gh-pages -d [dist] -s "[*.html,*.css]"

$ npx gh-pages -d [dist] -o [upstream]

gh-pages [options]

gh-pages is an npm package that publishes files to a GitHub Pages branch. It automates pushing built static sites to the gh-pages branch for hosting, creating clean commits of your distribution folder to the target branch.
The tool makes deployment a single command and is commonly used in CI/CD pipelines and as a package.json script.

-d, --dist dir

Directory to deploy.

File pattern within dist.

Target branch (default: gh-pages).

Remote name (default: origin).

Commit message.

Git user name.

Git user email.

Add files, don't remove existing.

Include dotfiles.

Add .nojekyll file.

package.json

Configure a deploy script with `"deploy": "gh-pages -d dist"` in the scripts section.

Requires git and npm. Overwrites target branch. GitHub Pages settings must be configured. May need --nojekyll for some sites. Credentials needed for push.

gh-pages was created by Tim Schaub to simplify GitHub Pages deployments. It became a standard tool in the JavaScript ecosystem for static site deployment.

gh(1), git(1), npm(1)