You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
peirstom opened this issue
May 5, 2022
· 1 comment
· Fixed by #7152
Labels
bugAn error in the Docusaurus core causing instability or issues with its executionexternalThis issue is caused by an external dependency and not Docusaurus.
A accessibility review was done by one of our customers and found the following:
The content of a page is structured by headings, among other things. To make this accessible to blind users, for example, HTML heading elements and their correct level hierarchy are an important prerequisite.
In a content document, the headings "Note" are always marked with level 5, although they partly follow headings of levels 1, 2 and 3. I would propose to not even use a Heading element for admonitions.
If we are to fix it, we will need to fork the dependency. Tracked in #6246. However, we have some complications around setting up our fork storage organization (@Docusaurus).
Would you be okay if I close this, since it's basically unactionable on our side, and we are fully aware of this problem for over a year now?
Josh-Cena
changed the title
Admonitions make the Heading hierarchy inconsisten
Admonitions make the Heading hierarchy inconsistent
May 6, 2022
Josh-Cena
added
bug
An error in the Docusaurus core causing instability or issues with its execution
and removed
proposal
This issue is a proposal, usually non-trivial change
labels
May 10, 2022
bugAn error in the Docusaurus core causing instability or issues with its executionexternalThis issue is caused by an external dependency and not Docusaurus.
Have you read the Contributing Guidelines on issues?
Motivation
A accessibility review was done by one of our customers and found the following:
The content of a page is structured by headings, among other things. To make this accessible to blind users, for example, HTML heading elements and their correct level hierarchy are an important prerequisite.
In a content document, the headings "Note" are always marked with level 5, although they partly follow headings of levels 1, 2 and 3. I would propose to not even use a Heading element for admonitions.
Self-service
The text was updated successfully, but these errors were encountered: