Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note about domain problem #375

Merged
merged 3 commits into from
May 24, 2021
Merged

Add note about domain problem #375

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e38a13
Add note about domain problem
demee Dec 28, 2020
665b1f5
Merge branch 'main' into patch-1
demee May 16, 2021
db0b483
Update readme.md
tschaub May 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,14 @@ The `gh-pages` module writes temporary files to a `node_modules/.cache/gh-pages`

If `gh-pages` fails, you may find that you need to manually clean up the cache directory. To remove the cache directory, run `node_modules/gh-pages/bin/gh-pages-clean` or remove `node_modules/.cache/gh-pages`.

### Deploying to github pages with custom domain

Modify the deployment line to your deploy script if you use custom domain. This will prevent deployment to remove the domain forom settings in github.
tschaub marked this conversation as resolved.
Show resolved Hide resolved

```
echo 'your_cutom_domain.online' > ./build/CNAME && gh-pages -d build"
```

### Deploying with GitHub Actions

In order to deploy with GitHub Actions, you will need to define a user and set the git repository for the process. See the example step below
Expand Down Expand Up @@ -427,3 +435,4 @@ You will need to utilize the `--` option to pass any additional arguments:
```

See [Pull Request #368](https://github.com/tschaub/gh-pages/pull/368) for more information.