Skip to content

Set up the GitHub Pages website - #117

Merged
matheuscscp merged 2 commits into
mainfrom
add-github-pages-site
Oct 24, 2026
Merged

matheuscscp merged 2 commits into
mainfrom
add-github-pages-site

Conversation

@matheuscscp

@matheuscscp matheuscscp commented Oct 24, 2026 •

Copy link
Copy Markdown
Owner

Sets up the GitHub Pages site and makes the README point readers back to the GitHub repository.

  • Adds a CNAME file so the site is served at https://cloudflare-gateway-controller.io.
  • Adds a View source badge and a note above the Mermaid diagram, since GitHub Pages does not render Mermaid and readers should go to the GitHub-rendered README to see it.

GitHub Pages is already enabled for this repository from main at / (legacy Jekyll build), which renders README.md as the site index and the docs/**/*.md pages at their corresponding URLs.

Do not merge this before applying the DNS below, otherwise the github.io URL will start redirecting to a domain that does not resolve to GitHub yet.

Cloudflare DNS

Cloudflare automatically flattens CNAME records at the zone apex, so only two records are needed (both DNS only, i.e. proxy disabled):

Type Name Value
CNAME @ matheuscscp.github.io
CNAME www matheuscscp.github.io

The existing 302 redirect to the GitHub repository must also be removed.

Alternative: GitHub's documented A/AAAA records

GitHub publishes four IPv4 and four IPv6 addresses for redundancy. The IPv6 addresses are optional; you can use just the four A records plus the www CNAME:

Type Name Value
A @ 185.199.108.153
A @ 185.199.109.153
A @ 185.199.110.153
A @ 185.199.111.153
AAAA @ 2606:50c0:8000::153
AAAA @ 2606:50c0:8001::153
AAAA @ 2606:50c0:8002::153
AAAA @ 2606:50c0:8003::153
CNAME www matheuscscp.github.io

Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
@matheuscscp matheuscscp changed the title Add GitHub Pages custom domain Set up the GitHub Pages website Oct 24, 2026
@matheuscscp
matheuscscp merged commit c066193 into main Oct 24, 2026
32 checks passed
@matheuscscp
matheuscscp deleted the add-github-pages-site branch October 24, 2026 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant