Normalize heading ids / anchors / hash to lowercase?

[slorber]

Have you read the Contributing Guidelines on issues?

• I have read the Contributing Guidelines on issues.

Motivation

Docusaurus anchor links are currently case sensitive (noticed by implementing the anchor broken link checker: #9528)

• this works: https://docusaurus.io/docs/next#design-principles
• this fails: https://docusaurus.io/docs/next#Design-Principles

---

Yet, many other sites implement case-insensitive anchors, and those links will usually work:

• https://developer.mozilla.org/en-US/docs/Learn/HTML#see_ALSO
• https://www.markdownguide.org/getting-started/#why-use-MARKDOWN
• https://jekyllrb.com/docs/posts/#including-IMAGES-and-resources
• https://www.11ty.dev/docs/languages/javascript/#proMISE

Note: this is not standard browser behavior, the links won't work with JavaScript disabled.

---

So: should we also implement this?

Considering this is a non-native behavior, it remains better for progressive enhancement to have correct case-sensitive links in the first place.

Should we report links with incorrect case in the anchor broken link checker?
(this won't block #9528 but we can do a follow-up PR)

Self-service

• I'd be willing to do some initial work on this proposal myself.

[Josh-Cena]

I'm +0.5 on this if other tools do the same. However, what if a page has two anchors with different casing? The thing that comes to mind is our write-heading-ids CLI which has an opt-in --maintain-case option, but this can also happen with hand-written ids.