From e5735e61d6f584d2538b66a08d5d5470bc6829ac Mon Sep 17 00:00:00 2001 From: Crist Ye Date: Mon, 5 Sep 2022 13:09:34 +0800 Subject: [PATCH 1/2] Using internationalized domain for GitHub Pages --- ...aging-a-custom-domain-for-your-github-pages-site.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index 05e0b384b9e5..8c4f08f9b6b7 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -46,6 +46,11 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +{% note %} + +Note: If your custom domain is an internationalized domain name, you need to enter the Punycode encoded version of it. + +{% endnote %} ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) 5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `another.example.com` for your organization site, create a `CNAME` record that points `another.example.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} @@ -72,6 +77,11 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +{% note %} + +Note: If your custom domain is an internationalized domain name, you need to enter the Punycode encoded version of it. + +{% endnote %} ![Save custom domain button](/assets/images/help/pages/save-custom-apex-domain.png) 5. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. You can also create `AAAA` records for IPv6 support. {% data reusables.pages.contact-dns-provider %} - To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %} From 7ee9b9bcdb25f70a6f18d972e8468554e98a526b Mon Sep 17 00:00:00 2001 From: Courtney Wilson Date: Fri, 30 Sep 2022 16:02:31 -0500 Subject: [PATCH 2/2] Update managing-a-custom-domain-for-your-github-pages-site.md --- ...ng-a-custom-domain-for-your-github-pages-site.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index 8c4f08f9b6b7..e1c0cc329d27 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -46,12 +46,16 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." +![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) + {% note %} -Note: If your custom domain is an internationalized domain name, you need to enter the Punycode encoded version of it. +**Note:** If your custom domain is an internationalized domain name, you must enter the Punycode encoded version. + +For more information on Punycodes, see [Internationalized domain name](https://en.wikipedia.org/wiki/Internationalized_domain_name). {% endnote %} - ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) + 5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `another.example.com` for your organization site, create a `CNAME` record that points `another.example.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} @@ -77,11 +81,6 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom {% data reusables.repositories.sidebar-settings %} {% data reusables.pages.sidebar-pages %} 4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[Configuring a publishing source for your GitHub Pages site](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." -{% note %} - -Note: If your custom domain is an internationalized domain name, you need to enter the Punycode encoded version of it. - -{% endnote %} ![Save custom domain button](/assets/images/help/pages/save-custom-apex-domain.png) 5. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. You can also create `AAAA` records for IPv6 support. {% data reusables.pages.contact-dns-provider %} - To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %}