Skip to content

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

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 Project DNS Configuration

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