Custom Domain Names

CNAME file

• The CNAME file contains the custom domain name, e.g., www.mkdocs-demo.org
• Do not include a CNAME file in the repo if you are not using a custom domain name, i.e., you are using the default URL

GitHub Info on Apex Domains

• Setting up an apex domain
• Setting up an apex domain and www subdomain

What is a DNS Resource Record?

About Resource Records

DNS Configuration

GitHub Project Configuration

• Create the required A (IPv4 address) records as described here
• Create a CNAME (canonical name) record for www and assign it the domain name of the project

DNS Config for Project on Google Domains

GitHub User Configuration

• Create the required A (IPv4 address) records as described here
• Create a CNAME (canonical name) record for www and assign it the domain name of the user

GitHub Organization Configuration

• Create the required A (IPv4 address) records as described here
• Create a CNAME (canonical name) record for www and assign it the domain name of the organization

Not working?

GitHub's tips for troubleshooting custom domains