Update github-pages.qmd to include instructions for custom domains #1298
Conversation
Adding instructions for publishing to custom domains.
docs/publishing/github-pages.qmd
Outdated
| @@ -103,6 +103,21 @@ If you are publishing to a private (i.e. password protected) website then the lo | |||
| quarto publish gh-pages --no-browser | |||
| ``` | |||
|
|
|||
| #### Custom Domains | |||
|
|
|||
| There are a few steps you will need to take to publish to a custom domain. First, [set up a CNAME record](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain) with your DNS provider. Next, in the Github repository for your site, edit the domain (Settings > Pages > Custom Domain). Then, add a file called CNAME to the root directory of your project. The only content of the file is the custom domain (e.g., `site.example.com`). Finally, add the `site-url` and the CNAME file to your `_quarto.yml` file like this: | |||
There was a problem hiding this comment.
Next, in the Github repository for your site, edit the domain (Settings > Pages > Custom Domain).
I wonder if there's a slightly cleaner way to provide the expected navigation here.
There was a problem hiding this comment.
I couldn't think of anything simpler, but happy to change it.
There was a problem hiding this comment.
I think that being a little more explicit would help, something like
Next, change the configuration on GitHub. In the webpage for your GitHub repository, click on "Settings", "Pages", and "Custom Domain", then enter the domain name in the text field.
There was a problem hiding this comment.
Ah! Good advice. I changed that, but the paragraph started to feel unwieldy, so I changed it to a numbered list.
Responding to code review, trying to simplify instructions.
Added more detail about subdomains, changed to numbered steps as paragraph was becoming unwieldy.
Adding instructions for publishing to custom domains.