Add an warning for using the CNAME parameter

See https://github.com/lektor/lektor/issues/322#issuecomment-260652270
This commit is contained in:
Ha Junsoo 2016-11-16 16:22:13 +09:00 committed by GitHub
parent 1d32e8aba8
commit fb9964a182
1 changed files with 5 additions and 2 deletions

View File

@ -45,14 +45,17 @@ with behavior for GitHub Pages.
## CNAME Support ## CNAME Support
If you want to use a [CNAME :ext](https://en.wikipedia.org/wiki/CNAME) with 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` custom domain configured GitHub pages and Lektor you can provide the intended
parameter: CNAME with the `?cname` parameter:
```ini ```ini
[servers.production] [servers.production]
target = ghpages://your-user/your-repository?cname=www.example.com 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 For more information about how CNAMEs work with GitHub you can read about
the feature in the GitHub help center: the feature in the GitHub help center:
[Adding a CNAME file to your repository [Adding a CNAME file to your repository