diff --git a/content/docs/deployment/ghpages/contents.lr b/content/docs/deployment/ghpages/contents.lr index ef82ceb4..6c56e769 100644 --- a/content/docs/deployment/ghpages/contents.lr +++ b/content/docs/deployment/ghpages/contents.lr @@ -44,15 +44,18 @@ with behavior for GitHub Pages. ## CNAME Support -If you want to use a [CNAME :ext](https://en.wikipedia.org/wiki/CNAME) with -GitHub pages and Lektor you can provide the intended CNAME with the `?cname` -parameter: +If you want to use a custom domain with GitHub pages (also known as a +[CNAME :ext](https://en.wikipedia.org/wiki/CNAME)), provide the intended +CNAME in the target URL using the `?cname` parameter: ```ini [servers.production] target = ghpages://your-user/your-repository?cname=www.example.com ``` +Note that this will overwrite whatever custom domain you may have set on +GitHub with every deployment. + For more information about how CNAMEs work with GitHub you can read about the feature in the GitHub help center: [Adding a CNAME file to your repository