Websites
/
lektor-website
mirror of https://github.com/lektor/lektor-website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #127 from kuc2477/patch-1 

Add an warning for using the CNAME parameter
This commit is contained in:
David Baumgold 2016-12-21 12:12:24 -05:00 committed by GitHub
parent aa47a4057b 78073ae5e4
commit 1d9e5b1b66
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
content/docs/deployment/ghpages/contents.lr
View File

@ -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