Skip to content

Add mention of custom domain when publishing site using GitHub Actions#8155

Merged
squidfunk merged 1 commit intosquidfunk:masterfrom
mschoettle:patch-1
Apr 10, 2025
Merged

Add mention of custom domain when publishing site using GitHub Actions#8155
squidfunk merged 1 commit intosquidfunk:masterfrom
mschoettle:patch-1

Conversation

@mschoettle
Copy link
Contributor

I ran into the issue that the CNAME file that GitHub creates when specifying the custom domain in the repo settings gets overwritten on the next deploy.

This PR adds a sentence and refers to the MkDocs docs that explain the addition of the CNAME file.

@squidfunk
Copy link
Owner

Thanks for the PR. Can we generalize this into "To publish your site on a custom domain, please refer to the MkDocs documentation"? This delegates the entire details to MkDocs, so if more things that are necessary to set up for custom domains appear in MkDocs' documentation, we don't need to change our guide. Thanks!

@mschoettle
Copy link
Contributor Author

Yes, that's a good idea. I like this better.

@squidfunk squidfunk merged commit 5d99a9f into squidfunk:master Apr 10, 2025
4 checks passed
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.

2 participants