doc: final round of markdown format changes

Once the README and find-inactive-collaborators.mjs changes land here, we can introduce markdown formatting as a step in the toolchain somewhere. Before this lands, nodejs/node-core-utils#578 will need to land and be included in a node-core-utils release. PR-URL: nodejs#40645 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
Trott · Oct 31, 2021 · 571e0b1 · 571e0b1
1 parent 1a6d927
commit 571e0b1
Show file tree

Hide file tree

Showing 10 changed files with 458 additions and 448 deletions.
diff --git a/README.md b/README.md
diff --git a/doc/api/esm.md b/doc/api/esm.md
@@ -1116,21 +1116,21 @@ The resolver can throw the following errors:
 >    **PACKAGE\_SELF\_RESOLVE**(_packageName_, _packageSubpath_, _parentURL_).
 > 10. If _selfUrl_ is not **undefined**, return _selfUrl_.
 > 11. While _parentURL_ is not the file system root,
->    1. Let _packageURL_ be the URL resolution of _"node_modules/"_
->       concatenated with _packageSpecifier_, relative to _parentURL_.
->    2. Set _parentURL_ to the parent folder URL of _parentURL_.
->    3. If the folder at _packageURL_ does not exist, then
->       1. Continue the next loop iteration.
->    4. Let _pjson_ be the result of **READ\_PACKAGE\_JSON**(_packageURL_).
->    5. If _pjson_ is not **null** and _pjson_._exports_ is not **null** or
->       **undefined**, then
->       1. Return the result of **PACKAGE\_EXPORTS\_RESOLVE**(_packageURL_,
->          _packageSubpath_, _pjson.exports_, _defaultConditions_).
->    6. Otherwise, if _packageSubpath_ is equal to _"."_, then
->       1. If _pjson.main_ is a string, then
->          1. Return the URL resolution of _main_ in _packageURL_.
->    7. Otherwise,
->       1. Return the URL resolution of _packageSubpath_ in _packageURL_.
+>     1. Let _packageURL_ be the URL resolution of _"node\_modules/"_
+>        concatenated with _packageSpecifier_, relative to _parentURL_.
+>     2. Set _parentURL_ to the parent folder URL of _parentURL_.
+>     3. If the folder at _packageURL_ does not exist, then
+>        1. Continue the next loop iteration.
+>     4. Let _pjson_ be the result of **READ\_PACKAGE\_JSON**(_packageURL_).
+>     5. If _pjson_ is not **null** and _pjson_._exports_ is not **null** or
+>        **undefined**, then
+>        1. Return the result of **PACKAGE\_EXPORTS\_RESOLVE**(_packageURL_,
+>           _packageSubpath_, _pjson.exports_, _defaultConditions_).
+>     6. Otherwise, if _packageSubpath_ is equal to _"."_, then
+>        1. If _pjson.main_ is a string, then
+>           1. Return the URL resolution of _main_ in _packageURL_.
+>     7. Otherwise,
+>        1. Return the URL resolution of _packageSubpath_ in _packageURL_.
 > 12. Throw a _Module Not Found_ error.
 
 **PACKAGE\_SELF\_RESOLVE**(_packageName_, _packageSubpath_, _parentURL_)
@@ -1242,7 +1242,7 @@ _internal_, _conditions_)
 >             1. Return **PACKAGE\_RESOLVE**(_target_ with every instance of
 >                _"\*"_ replaced by _subpath_, _packageURL_ + _"/"_).
 >          2. Return **PACKAGE\_RESOLVE**(_target_ + _subpath_,
->             _packageURL_ + _"/"_)_.
+>             _packageURL_ + _"/"_).
 >       2. Otherwise, throw an _Invalid Package Target_ error.
 >    3. If _target_ split on _"/"_ or _"\\"_ contains any _"."_, _".."_ or
 >       _"node\_modules"_ segments after the first segment, case insensitive and

diff --git a/doc/api/n-api.md b/doc/api/n-api.md
@@ -1009,8 +1009,8 @@ The content of the `napi_extended_error_info` returned is only valid up until
 a Node-API function is called on the same `env`. This includes a call to
 `napi_is_exception_pending` so it may often be necessary to make a copy
 of the information so that it can be used later. The pointer returned
-in error_message points to a statically defined string so it is safe to use
-that pointer if you have copied it out of the error_message field (which will
+in `error_message` points to a statically-defined string so it is safe to use
+that pointer if you have copied it out of the `error_message` field (which will
 be overwritten) before another Node-API function was called.
 
 Do not rely on the content or format of any of the extended information as it

diff --git a/doc/changelogs/CHANGELOG_V12.md b/doc/changelogs/CHANGELOG_V12.md
@@ -81,6 +81,7 @@
   * [Archive](CHANGELOG\_ARCHIVE.md)
 
 <a id="12.22.7"></a>
+
 ## 2021-10-12, Version 12.22.7 'Erbium' (LTS), @danielleadams
 
 This is a security release.
@@ -94,9 +95,9 @@ This is a security release.
 
 ### Commits
 
-* [[`21a2e554e3`](https://github.com/nodejs/node/commit/21a2e554e3)] - **deps**: update llhttp to 2.1.4 (Fedor Indutny) [nodejs-private/node-private#286](https://github.com/nodejs-private/node-private/pull/286)
-* [[`d5d3a03246`](https://github.com/nodejs/node/commit/d5d3a03246)] - **http**: add regression test for smuggling content length (Matteo Collina) [nodejs-private/node-private#286](https://github.com/nodejs-private/node-private/pull/286)
-* [[`0858587f21`](https://github.com/nodejs/node/commit/0858587f21)] - **http**: add regression test for chunked smuggling (Matteo Collina) [nodejs-private/node-private#286](https://github.com/nodejs-private/node-private/pull/286)
+* \[[`21a2e554e3`](https://github.com/nodejs/node/commit/21a2e554e3)] - **deps**: update llhttp to 2.1.4 (Fedor Indutny) [nodejs-private/node-private#286](https://github.com/nodejs-private/node-private/pull/286)
+* \[[`d5d3a03246`](https://github.com/nodejs/node/commit/d5d3a03246)] - **http**: add regression test for smuggling content length (Matteo Collina) [nodejs-private/node-private#286](https://github.com/nodejs-private/node-private/pull/286)
+* \[[`0858587f21`](https://github.com/nodejs/node/commit/0858587f21)] - **http**: add regression test for chunked smuggling (Matteo Collina) [nodejs-private/node-private#286](https://github.com/nodejs-private/node-private/pull/286)
 
 <a id="12.22.6"></a>
 

diff --git a/doc/changelogs/CHANGELOG_V14.md b/doc/changelogs/CHANGELOG_V14.md
@@ -69,6 +69,7 @@
   * [Archive](CHANGELOG\_ARCHIVE.md)
 
 <a id="14.18.1"></a>
+
 ## 2021-10-12, Version 14.18.1 'Fermium' (LTS), @danielleadams
 
 This is a security release.
@@ -82,9 +83,9 @@ This is a security release.
 
 ### Commits
 
-* [[`8c254ca7e4`](https://github.com/nodejs/node/commit/8c254ca7e4)] - **deps**: update llhttp to 2.1.4 (Fedor Indutny) [nodejs-private/node-private#285](https://github.com/nodejs-private/node-private/pull/285)
-* [[`9b92ae2499`](https://github.com/nodejs/node/commit/9b92ae2499)] - **http**: add regression test for smuggling content length (Matteo Collina) [nodejs-private/node-private#285](https://github.com/nodejs-private/node-private/pull/285)
-* [[`f467539719`](https://github.com/nodejs/node/commit/f467539719)] - **http**: add regression test for chunked smuggling (Matteo Collina) [nodejs-private/node-private#285](https://github.com/nodejs-private/node-private/pull/285)
+* \[[`8c254ca7e4`](https://github.com/nodejs/node/commit/8c254ca7e4)] - **deps**: update llhttp to 2.1.4 (Fedor Indutny) [nodejs-private/node-private#285](https://github.com/nodejs-private/node-private/pull/285)
+* \[[`9b92ae2499`](https://github.com/nodejs/node/commit/9b92ae2499)] - **http**: add regression test for smuggling content length (Matteo Collina) [nodejs-private/node-private#285](https://github.com/nodejs-private/node-private/pull/285)
+* \[[`f467539719`](https://github.com/nodejs/node/commit/f467539719)] - **http**: add regression test for chunked smuggling (Matteo Collina) [nodejs-private/node-private#285](https://github.com/nodejs-private/node-private/pull/285)
 
 <a id="14.18.0"></a>
 

diff --git a/doc/changelogs/CHANGELOG_V16.md b/doc/changelogs/CHANGELOG_V16.md
@@ -55,6 +55,7 @@
   * [Archive](CHANGELOG\_ARCHIVE.md)
 
 <a id="16.13.0"></a>
+
 ## 2021-10-26, Version 16.13.0 'Gallium' (LTS), @richardlau
 
 ### Notable Changes
@@ -65,21 +66,23 @@ and will remain so until October 2022. After that time, it will move into
 "Maintenance" until end of life in April 2024.
 
 <a id="16.12.0"></a>
+
 ## 2021-10-20, Version 16.12.0 (Current), @richardlau
 
 ### Notable Changes
 
 #### Experimental ESM Loader Hooks API
 
 Node.js ESM Loader hooks have been consolidated to represent the steps involved needed to facilitate future loader chaining:
-1. `resolve`: `resolve` \[+ `getFormat`\]
-1. `load`: `getFormat` + `getSource` + `transformSource`
+
+1. `resolve`: `resolve` \[+ `getFormat`]
+2. `load`: `getFormat` + `getSource` + `transformSource`
 
 For consistency, `getGlobalPreloadCode` has been renamed to `globalPreload`.
 
 A loader exporting obsolete hook(s) will trigger a single deprecation warning (per loader) listing the errant hooks.
 
-Contributed by Jacob Smith, Geoffrey Booth, and Bradley Farias - https://github.com/nodejs/node/pull/37468
+Contributed by Jacob Smith, Geoffrey Booth, and Bradley Farias - <https://github.com/nodejs/node/pull/37468>
 
 #### Other Notable Changes
 
@@ -150,6 +153,7 @@ Contributed by Jacob Smith, Geoffrey Booth, and Bradley Farias - https://github.
 * \[[`4116b6c907`](https://github.com/nodejs/node/commit/4116b6c907)] - **(SEMVER-MINOR)** **vm**: add support for import assertions in dynamic imports (Antoine du Hamel) [#40249](https://github.com/nodejs/node/pull/40249)
 
 <a id="16.11.1"></a>
+
 ## 2021-10-12, Version 16.11.1 (Current), @danielleadams
 
 This is a security release.
@@ -163,9 +167,9 @@ This is a security release.
 
 ### Commits
 
-* [[`af488f8dc8`](https://github.com/nodejs/node/commit/af488f8dc8)] - **deps**: update llhttp to 6.0.4 (Matteo Collina) [nodejs-private/node-private#284](https://github.com/nodejs-private/node-private/pull/284)
-* [[`2d1eefad98`](https://github.com/nodejs/node/commit/2d1eefad98)] - **http**: add regression test for smuggling content length (Matteo Collina) [nodejs-private/node-private#284](https://github.com/nodejs-private/node-private/pull/284)
-* [[`45d419ab1c`](https://github.com/nodejs/node/commit/45d419ab1c)] - **http**: add regression test for chunked smuggling (Matteo Collina) [nodejs-private/node-private#284](https://github.com/nodejs-private/node-private/pull/284)
+* \[[`af488f8dc8`](https://github.com/nodejs/node/commit/af488f8dc8)] - **deps**: update llhttp to 6.0.4 (Matteo Collina) [nodejs-private/node-private#284](https://github.com/nodejs-private/node-private/pull/284)
+* \[[`2d1eefad98`](https://github.com/nodejs/node/commit/2d1eefad98)] - **http**: add regression test for smuggling content length (Matteo Collina) [nodejs-private/node-private#284](https://github.com/nodejs-private/node-private/pull/284)
+* \[[`45d419ab1c`](https://github.com/nodejs/node/commit/45d419ab1c)] - **http**: add regression test for chunked smuggling (Matteo Collina) [nodejs-private/node-private#284](https://github.com/nodejs-private/node-private/pull/284)
 
 <a id="16.11.0"></a>