Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blockquote misuse #2752

Closed
toastal opened this issue Oct 7, 2024 · 1 comment · Fixed by #2753
Closed

Blockquote misuse #2752

toastal opened this issue Oct 7, 2024 · 1 comment · Fixed by #2753

Comments

@toastal
Copy link

toastal commented Oct 7, 2024

I was reading the page: https://ocaml.org/docs/installing-ocaml

Blockquotes are being used incorrectly.

scrot-2024-10-07_1286x145

scrot-2024-10-07_1310x453

The blockquote element represents a section that is quoted from
another source.

— W3C HTML spec, https://html.spec.whatwg.org/multipage/grouping-content.html#the-blockquote-element

There are more instances around these docs of blockquotes not referencing text from some other source. It appears these are being meant to be used a callout/admonition. Due to the choice of Markdown (not sure which fork) for lightweight markup over a different syntax that supports them, there is no support for these common elements for technical documentation. Regardless <blockquote> isn’t the semantic element for this & shouldn’t be used.

@cuihtlauac
Copy link
Collaborator

cuihtlauac commented Oct 7, 2024

Thanks @toastal. You are right; quotations are for quotations. PR #2753 tentatively fixes this.

If you spot other such issues, we'd love to have a patch from you on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants