From fb9964a182ebe74f82e906866f120b79878293c9 Mon Sep 17 00:00:00 2001 From: Ha Junsoo Date: Wed, 16 Nov 2016 16:22:13 +0900 Subject: [PATCH 1/2] Add an warning for using the CNAME parameter See https://github.com/lektor/lektor/issues/322#issuecomment-260652270 --- content/docs/deployment/ghpages/contents.lr | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) 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 From 78073ae5e4abb39a1186d6f61b2a6c5f1d3f9fe9 Mon Sep 17 00:00:00 2001 From: Ha Junsoo Date: Mon, 28 Nov 2016 17:19:46 +0900 Subject: [PATCH 2/2] Update contents.lr --- content/docs/deployment/ghpages/contents.lr | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/docs/deployment/ghpages/contents.lr b/content/docs/deployment/ghpages/contents.lr index fefa03ee..6c56e769 100644 --- a/content/docs/deployment/ghpages/contents.lr +++ b/content/docs/deployment/ghpages/contents.lr @@ -44,17 +44,17 @@ with behavior for GitHub Pages. ## CNAME Support -If you want to use a [CNAME :ext](https://en.wikipedia.org/wiki/CNAME) with -custom domain configured 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 your Github page's custom domain setting -with given `?cname` parameter on every deployment. +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: