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.

Sign up for GitHub

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

Jump to bottom

doc,tools: use only one level 1 header per page #37839

Merged
merged 2 commits into from Mar 25, 2021
Merged

doc,tools: use only one level 1 header per page #37839

merged 2 commits into from Mar 25, 2021
+52 −45

Commits on Mar 25, 2021

  1. doc: reduce header nesting in async_hooks.md 

    Maximum header level reduced to 5.

PR-URL: nodejs#37839
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
    @Trott
    Trott committed Mar 25, 2021
    Configuration menu
    Copy the full SHA
    8262f7a View commit details
    Browse the repository at this point in the history

  2. doc,tools: use only one level 1 header per page 

    Increment the header levels from markdown files when producing HTML
documents. This is both better semantically (as the two h1 headers in
current docs are not actually equivalent level semantically--the second
belongs below/inside the first) and better for accessibility. (It is
valid HTML to have multiple h1 headers in a document, but it can be bad
for screen reader experience.)

PR-URL: nodejs#37839
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
    @Trott
    Trott committed Mar 25, 2021
    Configuration menu
    Copy the full SHA
    3700ba0 View commit details
    Browse the repository at this point in the history