Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/samgutentag/sbburgerweek/llms.txt

Use this file to discover all available pages before exploring further.

A custom domain gives your map a cleaner, event-specific URL — something like sbburritoweekmap.com — instead of the default username.github.io/sbburgerweek path. The CNAME file in the repo and the GitHub Pages custom domain setting work together to route traffic correctly. The CNAME file is managed automatically by apply-theme.py, so you won’t need to edit it by hand.

​
Buy a domain

Any domain registrar works. Popular options include Namecheap, Cloudflare Registrar, and Google Domains. Pick whichever you’re comfortable with — the DNS steps below are the same regardless of registrar.

​
Set up DNS

Add the following records at your DNS provider. The four A records point the apex domain (@) to GitHub Pages’ IP addresses, and the CNAME record points the www subdomain to your GitHub Pages URL.
TypeNameValue
A@185.199.108.153
A@185.199.109.153
A@185.199.110.153
A@185.199.111.153
CNAMEwwwYOUR_USERNAME.github.io
Replace YOUR_USERNAME with your actual GitHub username. DNS changes can take a few minutes to a few hours to propagate depending on your provider’s TTL settings.
Cloudflare DNS proxy must be turned OFF. If your domain’s DNS is managed through Cloudflare, make sure the proxy toggle is set to the grey cloud (DNS only) for every record pointing to GitHub Pages. When the orange cloud (proxied) is on, GitHub cannot issue an SSL certificate via Let’s Encrypt and your site will show HTTPS errors.

​
Configure GitHub Pages

Once your DNS records are saved, connect the domain to your repository:
  1. Go to your repo on GitHub → Settings → Pages
  2. Under Custom domain, enter your domain (e.g. sbburritoweekmap.com) and click Save
  3. GitHub will run a DNS check. Once it passes, check Enforce HTTPS
The DNS check can take up to 24 hours, but usually completes within a few minutes. The HTTPS checkbox becomes available automatically once the check passes and Let’s Encrypt issues a certificate.

​
Update config.js

Set siteUrl in config.js to your custom domain, then run apply-theme.py to propagate the change: 
siteUrl: "https://sbburritoweekmap.com",

python3 apply-theme.py
apply-theme.py reads siteUrl from config.js, extracts the domain, and writes it to the CNAME file. It also updates the og-image.svg, og-image.png, OG meta tags in HTML pages, the Hits badge URL in README.md, and the embed snippet domain — all from that single siteUrl value.
You don’t need to edit the CNAME file manually. apply-theme.py rewrites it automatically every time you run it. The current CNAME in the original repo contains sbburgerweekmap.com — after you update siteUrl and run the script, it will contain your domain instead.

Build docs developers (and LLMs) love

Get started for freeTalk to us