diff --git a/content/docs/deployment/ghpages/contents.lr b/content/docs/deployment/ghpages/contents.lr index ef82ceb4..fefa03ee 100644 --- a/content/docs/deployment/ghpages/contents.lr +++ b/content/docs/deployment/ghpages/contents.lr @@ -45,14 +45,17 @@ 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: +custom domain configured GitHub pages and Lektor you can provide the intended +CNAME with the `?cname` parameter: ```ini [servers.production] target = ghpages://your-user/your-repository?cname=www.example.com ``` +Note that this will overwrite your Github page's custom domain setting +with given `?cname` parameter on 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