Skip to content

Commit

Permalink
📝 Add FAQ about custom domains
Browse files Browse the repository at this point in the history
  • Loading branch information
McPringle committed Jun 20, 2024
1 parent dbf0f29 commit b77cf3f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,15 @@ from the GitHub repository and (ii) `html` file when openning this page from the


endif::[]

== FAQ

=== How can I configure a custom domain?

GitHub Pages need a `CNAME` file on the `gh-pages` branch. But on every action run, the `gh-pages` branch is wiped out. To make a custom domain work, the easiest solution is to configure a pre build command:

```yml
pre_build: echo "your.custom.domain" > CNAME && git add -f CNAME
```

When you add this command to your action configuration, it will create the required `CNAME` file and add it to git.

0 comments on commit b77cf3f

Please sign in to comment.