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 a4c6e2e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,9 @@ 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, just add the `CNAME` file in the root directory of your `main` or `master` branch instead and it will be copied over to the `gh-pages` branch automatically. If you have a `source_dir` configured, the `CNAME` file must be inside your configured `source_dir`.

0 comments on commit a4c6e2e

Please sign in to comment.