"Manage a custom domain" > "Configuring a subdomain" has broken formatting

[Marcono1234]

Code of Conduct

• [X] I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

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

What part(s) of the article would you like to see updated?

The number of the list items seems incorrect; "Navigate to your DNS provider and create..." is currently numbered as "1" but should probably be numbered as "5": https://github.com/github/docs/blob/88c31e99c779fbf721caf7fac222ad369be8bc0c/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md?plain=1#L59

---

The Markdown rendering of the warning box is broken:

Note: That warning box is actually used multiple times, but only the rendering of this occurrence is broken.

Additional information

I am not going to submit a pull request because I am not familiar enough with how these Markdown files are processed and why these issues might occur.

[chrissygem42]

---

From: Marcono1234 @.***> Sent: Sunday, November 20, 2022 4:09:20 PM To: github/docs Cc: Subscribed Subject: [github/docs] "Manage a custom domain" > "Configuring a subdomain" has broken formatting (Issue #22180)

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conducthttps://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md

What article on docs.github.com is affected?

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

What part(s) of the article would you like to see updated?

The number of the list items seems incorrect; "Navigate to your DNS provider and create..." is currently numbered as "1" but should probably be numbered as "5": https://github.com/github/docs/blob/88c31e99c779fbf721caf7fac222ad369be8bc0c/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md?plain=1#L59

[Incorrect numbering screenshot]https://user-images.githubusercontent.com/11685886/202912471-93787055-7299-4503-85a0-5b482c18c68b.png

---

The Markdown rendering of the warning box is broken: [Broken Markdown rendering screenshot]https://user-images.githubusercontent.com/11685886/202912510-2bab2b91-1635-4336-8398-7d812ba608e6.png

Note: That warning box is actually used multiple times, but only the rendering of this occurrence is broken.

Additional information

I am not going to submit a pull request because I am not familiar enough with how these Markdown files are processed and how why these issues might occur.

— Reply to this email directly, view it on GitHubhttps://github.com/github/docs/issues/22180, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A2MGJ7YEPLNDUXJEW4B3B2TWJJELBANCNFSM6AAAAAASF5DTR4. You are receiving this because you are subscribed to this thread.Message ID: @.***>

[TPVdZoHteuquuW5uZHR5Jac88vrgQnUYm7]

Sent from my Galaxy -------- Original message --------From: chrissygem42 @.> Date: 21/11/2022 12:02 am (GMT+06:00) To: github/docs @.> Cc: Subscribed @.***> Subject: Re: [github/docs] "Manage a custom domain" > "Configuring a subdomain" has broken formatting (Issue #22180)

---

From: Marcono1234 @.***>

Sent: Sunday, November 20, 2022 4:09:20 PM

To: github/docs

Cc: Subscribed

Subject: [github/docs] "Manage a custom domain" > "Configuring a subdomain" has broken formatting (Issue #22180)

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conducthttps://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md

What article on docs.github.com is affected?

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

What part(s) of the article would you like to see updated?

The number of the list items seems incorrect; "Navigate to your DNS provider and create..." is currently numbered as "1" but should probably be numbered as "5":

https://github.com/github/docs/blob/88c31e99c779fbf721caf7fac222ad369be8bc0c/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md?plain=1#L59

[Incorrect numbering screenshot]https://user-images.githubusercontent.com/11685886/202912471-93787055-7299-4503-85a0-5b482c18c68b.png

---

The Markdown rendering of the warning box is broken:

[Broken Markdown rendering screenshot]https://user-images.githubusercontent.com/11685886/202912510-2bab2b91-1635-4336-8398-7d812ba608e6.png

Note: That warning box is actually used multiple times, but only the rendering of this occurrence is broken.

Additional information

I am not going to submit a pull request because I am not familiar enough with how these Markdown files are processed and how why these issues might occur.

—

Reply to this email directly, view it on GitHubhttps://github.com/github/docs/issues/22180, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A2MGJ7YEPLNDUXJEW4B3B2TWJJELBANCNFSM6AAAAAASF5DTR4.

You are receiving this because you are subscribed to this thread.Message ID: @.***>

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: @.***>

[cmwilson21]

@Marcono1234 Thanks so much for opening an issue and providing screenshots! ✨

I'll triage this for the team to take a look :eyes:

[sophietheking]

@Marcono1234 thanks for opening this issue! 💖 The broken Markdown warning doesn't seem to be visible on my end, so I'm wondering if it might have been a temporary issue that has been fixed already. But please let us know if you're still seeing it!

The numbered list should definitely be fixed, this can be done by adding some whitespacing before the note so it aligns with the text:

  {% note %}

  **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 %}

I triaged the issue and you (or anyone else!) are welcome to open a PR. 🚀