Rich Trott
bc056c2426
doc: add main ARIA landmark to API docs
...
As an accessibility improvement, specify the main landmark for
the column in our docs that contains the main content.
Ref: https://www.w3.org/WAI/ARIA/apg/practices/landmark-regions/
Ref: https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA20.html
PR-URL: https://github.com/nodejs/node/pull/49882
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Claudio Wunder <cwunder@gnome.org >
Reviewed-By: LiviaMedeiros <livia@cirno.name >
2023-09-28 14:08:52 -07:00
Antoine du Hamel
3ce4cef4e6
tools: enforce use of trailing commas in tools/
...
PR-URL: https://github.com/nodejs/node/pull/45889
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com >
2022-12-18 16:39:39 +00:00
Antoine du Hamel and Moshe Atlow
7cbcc4fc43
tools: fix CJS/ESM toggle on small screens
...
PR-URL: https://github.com/nodejs/node/pull/43506
Co-authored-by: Moshe Atlow <moshe@atlow.co.il >
Fixes: https://github.com/nodejs/node/issues/43468
Reviewed-By: LiviaMedeiros <livia@cirno.name >
2022-06-27 18:31:44 +02:00
Tobias Nießen
400b7c242b
tools: use Set instead of { [key]: true } object
...
PR-URL: https://github.com/nodejs/node/pull/41675
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2022-01-24 11:46:47 +00:00
Rich Trott and Tobias Nießen
500241d50d
tools: replace for loop with map()
...
Refs: https://github.com/nodejs/node/pull/41406#discussion_r778979676
Co-authored-by: Tobias Nießen <tniessen@tnie.de >
PR-URL: https://github.com/nodejs/node/pull/41451
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com >
2022-01-12 22:10:39 -08:00
Rich Trott
e247089057
tools: replace while+exec() with matchAll()
...
PR-URL: https://github.com/nodejs/node/pull/41406
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
2022-01-09 03:46:56 +00:00
Rich Trott
83f442a1fa
tools: avoid generating duplicate id attributes
...
In all.html, we currently generate hundreds of duplicate id attributes
because of conflicts between the way allhtml.mjs prefixes in-page links
with the module name on the one hand, and the existence of legacy id
attributes hardcoded into the page on the other hand.
This prefaces the module name with `all_` to avoid the conflicts.
PR-URL: https://github.com/nodejs/node/pull/41291
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: James M Snell <jasnell@gmail.com >
2021-12-25 05:59:33 +00:00
Rich Trott
179248a7b9
tools: udpate doc tools to accommodate GFM footnotes
...
PR-URL: https://github.com/nodejs/node/pull/40477
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2021-10-23 06:13:18 -07:00
foxxyz
6fdd5827f0
doc: anchor link parity between markdown and html-generated docs
...
Main changes:
- Replace current HTML anchor generation to match
header anchor generation in Github markdown.
- Remove unnecessary double namespacing on generated anchors/links (E.G.
`esm.md#loaders` instead of `esm.md#esm_loaders`).
- Anchors/links are automatically prefixed with their respective modules
when concatenated for usage in `all.html`.
Benefits:
- All anchor links within and between markdown API docs actually work.
- Adding new anchor links no longer requires contributors to generate
the HTML docs first to look up the correct anchors.
- Anchors are much shorter.
- All previous anchor links are preserved by generating hidden legacy
anchors.
PR-URL: https://github.com/nodejs/node/pull/39304
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2021-08-30 00:40:20 +02:00
Rich Trott
ad5dc4c469
tools: make internal link checker more robust
...
The internal link checker was missing some broken links because it was
being too restrictive about the characters it accepted as part of a link
hash. Accept anything that isn't a terminating quotation mark.
Refs: https://github.com/nodejs/node/pull/39426
Refs: https://github.com/nodejs/node/pull/39425
PR-URL: https://github.com/nodejs/node/pull/39429
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Zeyu Yang <himself65@outlook.com >
2021-07-20 14:13:59 +00:00
Michaël Zasso and Antoine du Hamel
de01f475d5
tools: update doctool dependencies, migrate to ESM
...
- Migrated to ESM because some dependencies now require it.
- Did not update `highlight.js` to v11 because it has many breaking
changes.
- Used non-deprecated `highlight.js` API.
Refs: https://github.com/highlightjs/highlight.js/issues/2277
Fixes: https://github.com/nodejs/node/issues/38938
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/38966
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Richard Lau <rlau@redhat.com >
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2021-06-14 08:22:00 -07:00
Rich Trott