gh-pages - Shell/Bash

gh-pages is a command-line tool for publishing files to a GitHub Pages branch on a repository. It is written in JavaScript and can be installed via npm.

Installation

To install gh-pages, you need to have npm installed on your system. You can install gh-pages globally with the following command:

npm install -g gh-pages

Usage

Initializing a gh-pages branch

To initialize a gh-pages branch, you need to first create an empty branch called gh-pages in your repository:

git checkout --orphan gh-pages
git rm -rf .
touch README.md
git add README.md
git commit -m "Initial commit"
git push origin gh-pages

Publishing a directory to gh-pages branch

After initializing the gh-pages branch, you can publish a directory (e.g. your project's build directory) to the gh-pages branch using the following command:

gh-pages -d <directory>

This will push the contents of the directory to the gh-pages branch on the repository.

Customizing settings

You can customize the settings for gh-pages in a few ways:

• Specify a custom directory to publish: gh-pages -d <directory>
• Specify a branch to publish to: gh-pages -b <branch>
• Specify a custom commit message: gh-pages -m "<commit message>"
• Specify a custom remote: gh-pages -r <remote>

Conclusion

gh-pages is a powerful tool for publishing static websites and other assets to a GitHub Pages branch. Its ease of use and flexibility make it a popular choice for developers looking to quickly deploy their projects.