From 059c535f154a8a2853dc72b1ca5dd9c005d57d75 Mon Sep 17 00:00:00 2001
From: Marcus Fihlon <marcus@fihlon.swiss>
Date: Thu, 20 Jun 2024 09:24:09 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20FAQ=20about=20custom=20dom?=
 =?UTF-8?q?ains?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.adoc | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.adoc b/README.adoc
index 2083031..b93c3fb 100644
--- a/README.adoc
+++ b/README.adoc
@@ -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`.