Simple CLI tool to deploy to github pages.
Code is directly placed in /bin to make npm CLI create the CLI commands within /node_modules when installing this without having to go through an additonal build/release step of copying the file over.
-
--dir
- Pass in a directory other than the default
./docs
to deploy
- Pass in a directory other than the default
-
--message
- Pass a custom commit message instead of the default
[Github pages deployment commit]
- Message must be wrapped in quotes if longer than a single string
- Pass a custom commit message instead of the default
# Install as dev dependency
npm install -D simple-github-pages-deploy
# Use npx to run it
# Uses all the default options
npx simple-github-pages-deploy
"scripts": {
"deploy": "npx simple-github-pages-deploy"
},
npx simple-github-pages-deploy --dir ./dist --message "github pages deployment"
-
git
must be installed and available globally from the shell