Skip to content

Commit

Permalink
Include CNAME file (#83)
Browse files Browse the repository at this point in the history
* update README.md file

* Update README.md with CNAME doc link
  • Loading branch information
viniciuspereiras authored Jan 13, 2022
1 parent f7bb107 commit 6a6c1ca
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ tag_permalink_style: pretty
tag_page_layout: tag_page
tag_page_dir: tag

# for github pages custom domains:
# include: [CNAME]

dash:
# the way how dates should be displayed
date_format: "%b %-d, %Y"
Expand Down Expand Up @@ -115,6 +118,12 @@ I have created [a guide on how to set this up here](https://bitbra.in/2021/10/03

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!

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:
```
include: [CNAME]
```
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).

## Additional Features

**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`:
Expand Down

0 comments on commit 6a6c1ca

Please sign in to comment.