reword BlockQuoteKind -> AdmonitionKind, render as div#1069
reword BlockQuoteKind -> AdmonitionKind, render as div#1069orangecms wants to merge 2 commits intopulldown-cmark:mainfrom
Conversation
|
Please check the formatting errors. Also, I miss documentation about this in the mdBook (although it currently does not exist): Thanks! |
The extended GFM reuses blocks that are usually for quote also for admonitions, so while the notation is ambiguous, we can distinguish the semantics. This is an API breakage for library users. The rendering as a `<div role="note">` is semantically more adequate and more suitable for assistive tooling. There is no semantic HTML element for this purpose at this point. For reference, see - <https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/note_role> - <https://www.w3.org/TR/WCAG21/#name-role-value> Signed-off-by: Daniel Maslowski <info@orangecms.org>
a6da33e to
2e2531f
Compare
|
whoops, yup, formatting fixed 😅 What do you mean by "documentation about this in the mdBook"? What am I missing? 🥺 |
|
Admonition support in the guide (I think that's what you mean by "the mdBook"?) is currently mentioned in
|
|
Would you like me to add to |
Signed-off-by: Daniel Maslowski <info@orangecms.org>
|
Yes, I meant |
|
I have checked the output of the job and the admonitions spec is not generated, probably an error in the script that generates the Markdown files. |
|
That would be for another PR then, though? |
|
Yes, a different pull request, but it should be fixed before launching 0.14 release 🙂. A long time has passed since the last release, so this is a good moment for a breaking new release. Everything is fine on my side, but I would like the approval of @notriddle. Also, before the 0.14 release we should consider to take into account #1013 pull request. Thanks! |
|
Oh I see, #1013 also renders as divs - I would happily rebase, should that one go first. It's bigger, so not as much effort for me. :) |
The extended GFM reuses blocks that are usually for quote also for admonitions, so while the notation is ambiguous, we can distinguish the semantics. This is an API breakage for library users.
The rendering as a
<div role="note">is semantically more adequate and more suitable for assistive tooling. There is no semantic HTML element for this purpose at this point. For reference, seevia #1068