Skip to content

Commit

Permalink
fix(project): fix for custom domains base url
Browse files Browse the repository at this point in the history
  • Loading branch information
jwpradm committed Dec 20, 2021
1 parent 2250f33 commit 2426b27
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/easy-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

<br />

Expand Down
3 changes: 2 additions & 1 deletion scripts/deploy-github.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ function getBaseUrl() {
return envBaseUrl;
}
const defaultBaseUrl = customDomain
? '/'
? ''
: '/' + getGithubDir() + '/';
return defaultBaseUrl;
}
Expand Down Expand Up @@ -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'));
}
Expand Down

0 comments on commit 2426b27

Please sign in to comment.