HTML semantics for admonitions #3026
Description
Problem
With #2851 came support for admonitions. 🎉
They are currently being rendered using <blockquote> elements, albeit being remarks/notes here.
That element is meant for actual quotes; see https://html.spec.whatwg.org/multipage/grouping-content.html#the-blockquote-element
GitHub themselves are using <div> elements, which has no semantics at all though; see https://gist.github.com/cseeman/8f3bfaec084c5c4259626ddd9e516c61 (open browser dev tools).
There is unfortunately no suitable semantic HTML element, as of now.
However a semantic role attribute value exists:
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/note_role (even mentions blockquote to be used where suitable)
this role is e.g. used in the WCAG guidlines; see e.g. the note under https://www.w3.org/TR/WCAG21/#name-role-value
... coming from kubernetes-sigs/kubebuilder#5457 😅
Proposed Solution
Switch to <div role="note">. I will happily file a PR. :)
Notes
No response