Skip to content

Commit 6a6c1ca

Browse files
Include CNAME file (#83)
* update README.md file * Update README.md with CNAME doc link
1 parent f7bb107 commit 6a6c1ca

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ tag_permalink_style: pretty
6969
tag_page_layout: tag_page
7070
tag_page_dir: tag
7171

72+
# for github pages custom domains:
73+
# include: [CNAME]
74+
7275
dash:
7376
# the way how dates should be displayed
7477
date_format: "%b %-d, %Y"
@@ -115,6 +118,12 @@ I have created [a guide on how to set this up here](https://bitbra.in/2021/10/03
115118

116119
You are not required to do this, but keep in mind that some functionality might not be available when using the Jekyll generator on Github directly!
117120

121+
If you are using a custom domain add in your main branch a file named CNAME with your domain there and uncomment this line in your config file:
122+
```
123+
include: [CNAME]
124+
```
125+
For more information about how to configure your CNAME file, read the [official documentation](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site).
126+
118127
## Additional Features
119128

120129
**Tagging** add the `jekyll/tagging` plugin to your `_config.yml` file to enable tagging. Do not forget to also add the following to your `Gemfile`:

0 commit comments

Comments
 (0)