diff --git a/docs/easy-deployments.md b/docs/easy-deployments.md index c4af18170..486018a7e 100644 --- a/docs/easy-deployments.md +++ b/docs/easy-deployments.md @@ -29,10 +29,10 @@ Github pages have some [usage limits](https://docs.github.com/en/pages/getting-s ### Usage Instructions -1. Confirm that you can [build this project from source](./build-from-source.md). Be sure to install optional dependencies. -2. Enable the [Github Pages feature](https://docs.github.com/en/pages/getting-started-with-github-pages) for the `gh-pages` branch in your repository. -3. Run `yarn deploy:github`. Be sure to follow the instructions that appear on the screen. -4. (Optional) If you need a customization option, review `yarn deploy:github --help`. +1. (Optional) If you need a customization option, review `yarn deploy:github --help`. +2. Confirm that you can [build this project from source](./build-from-source.md). Be sure to install optional dependencies. +3. Enable the [Github Pages feature](https://docs.github.com/en/pages/getting-started-with-github-pages) for the `gh-pages` branch in your repository. +4. Run `yarn deploy:github`. Be sure to follow the instructions that appear on the screen. If you want to connect your github deployment to a custom domain remember to add `--custom-domain=mydomain.com`
diff --git a/scripts/deploy-github.js b/scripts/deploy-github.js index 2a6e7596a..af37f8460 100644 --- a/scripts/deploy-github.js +++ b/scripts/deploy-github.js @@ -68,7 +68,7 @@ function getBaseUrl() { return envBaseUrl; } const defaultBaseUrl = customDomain - ? '/' + ? '' : '/' + getGithubDir() + '/'; return defaultBaseUrl; } @@ -111,6 +111,7 @@ function help() { "--deploy - don't ask for deploy confirmation", '--deploy-args="--help" - pass arguments to gh-pages, in this case gh-pages --help', '--github-remote="origin" - select github remote to use to detect github project name, default is "origin"', + '--custom-domain="example.com" - (no slashes) deploy to custom domain instead of github directory', '', ].join('\n')); }