doc: use .md extension for internal links

This helps catch broken links as part of the test suite. This also improves the user experience when browsing the markdown files. PR-URL: #35191 Fixes: #35189 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Jiawen Geng <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Rich Trott <[email protected]>
nodejs · Oct 6, 2020 · ce789f1 · ce789f1
1 parent f23a0e2
commit ce789f1
Show file tree

Hide file tree

Showing 55 changed files with 732 additions and 672 deletions.
diff --git a/doc/api/addons.md b/doc/api/addons.md
@@ -10,7 +10,7 @@ Addons provide an interface between JavaScript and C/C++ libraries.
 There are three options for implementing addons: N-API, nan, or direct
 use of internal V8, libuv and Node.js libraries. Unless there is a need for
 direct access to functionality which is not exposed by N-API, use N-API.
-Refer to [C/C++ addons with N-API](n-api.html) for more information on N-API.
+Refer to [C/C++ addons with N-API](n-api.md) for more information on N-API.
 
 When not using N-API, implementing addons is complicated,
 involving knowledge of several components and APIs:
@@ -452,7 +452,7 @@ in the N-API are used.
 
 Creating and maintaining an addon that benefits from the ABI stability
 provided by N-API carries with it certain
-[implementation considerations](n-api.html#n_api_implications_of_abi_stability).
+[implementation considerations](n-api.md#n_api_implications_of_abi_stability).
 
 To use N-API in the above "Hello world" example, replace the content of
 `hello.cc` with the following. All other instructions remain the same.
@@ -490,7 +490,7 @@ NAPI_MODULE(NODE_GYP_MODULE_NAME, init)
 ```
 
 The functions available and how to use them are documented in
-[C/C++ addons with N-API](n-api.html).
+[C/C++ addons with N-API](n-api.md).
 
 ## Addon examples
 
@@ -1356,7 +1356,7 @@ console.log(result);
 // Prints: 30
 ```
 
-[`Worker`]: worker_threads.html#worker_threads_class_worker
+[`Worker`]: worker_threads.md#worker_threads_class_worker
 [Electron]: https://electronjs.org/
 [Embedder's Guide]: https://github.com/v8/v8/wiki/Embedder's%20Guide
 [Linking to libraries included with Node.js]: #addons_linking_to_libraries_included_with_node_js
@@ -1367,5 +1367,5 @@ console.log(result);
 [installation instructions]: https://github.com/nodejs/node-gyp#installation
 [libuv]: https://github.com/libuv/libuv
 [node-gyp]: https://github.com/nodejs/node-gyp
-[require]: modules.html#modules_require_id
+[require]: modules.md#modules_require_id
 [v8-docs]: https://v8docs.nodesource.com/
diff --git a/doc/api/assert.md b/doc/api/assert.md
@@ -64,7 +64,7 @@ assert.deepEqual([[[1, 2, 3]], 4, 5], [[[1, 2, '3']], 4, 5]);
 To deactivate the colors, use the `NO_COLOR` or `NODE_DISABLE_COLORS`
 environment variables. This will also deactivate the colors in the REPL. For
 more on color support in terminal environments, read the tty
-[getColorDepth()](tty.html#tty_writestream_getcolordepth_env) documentation.
+[getColorDepth()](tty.md#tty_writestream_getcolordepth_env) documentation.
 
 ## Legacy assertion mode
 
@@ -1558,15 +1558,15 @@ argument.
 
 [`AssertionError`]: #assert_class_assert_assertionerror
 [`Class`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
-[`ERR_INVALID_RETURN_VALUE`]: errors.html#errors_err_invalid_return_value
-[`Error.captureStackTrace`]: errors.html#errors_error_capturestacktrace_targetobject_constructoropt
-[`Error`]: errors.html#errors_class_error
+[`ERR_INVALID_RETURN_VALUE`]: errors.md#errors_err_invalid_return_value
+[`Error.captureStackTrace`]: errors.md#errors_error_capturestacktrace_targetobject_constructoropt
+[`Error`]: errors.md#errors_class_error
 [`Map`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
 [`Object.is()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is
 [`RegExp`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
 [`Set`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
 [`Symbol`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol
-[`TypeError`]: errors.html#errors_class_typeerror
+[`TypeError`]: errors.md#errors_class_typeerror
 [`WeakMap`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
 [`WeakSet`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet
 [`CallTracker`]: #assert_class_assert_calltracker
@@ -1581,7 +1581,7 @@ argument.
 [`assert.ok()`]: #assert_assert_ok_value_message
 [`assert.strictEqual()`]: #assert_assert_strictequal_actual_expected_message
 [`assert.throws()`]: #assert_assert_throws_fn_error_message
-[`process.on('exit')`]: process.html#process_event_exit
+[`process.on('exit')`]: process.md#process_event_exit
 [`tracker.calls()`]: #assert_tracker_calls_fn_exact
 [`tracker.verify()`]: #assert_tracker_verify
 [strict assertion mode]: #assert_strict_assertion_mode

diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md
@@ -1173,10 +1173,10 @@ to associate the asynchronous operation with the correct execution context.
 [`destroy` callback]: #async_hooks_destroy_asyncid
 [`init` callback]: #async_hooks_init_asyncid_type_triggerasyncid_resource
 [`promiseResolve` callback]: #async_hooks_promiseresolve_asyncid
-[`EventEmitter`]: events.html#events_class_eventemitter
+[`EventEmitter`]: events.md#events_class_eventemitter
 [Hook Callbacks]: #async_hooks_hook_callbacks
 [PromiseHooks]: https://docs.google.com/document/d/1rda3yKGHimKIhg5YeoAmCOtyURgsbTH_qaYR79FELlk/edit
-[`Stream`]: stream.html#stream_stream
-[`Worker`]: worker_threads.html#worker_threads_class_worker
+[`Stream`]: stream.md#stream_stream
+[`Worker`]: worker_threads.md#worker_threads_class_worker
 [promise execution tracking]: #async_hooks_promise_execution_tracking
-[`util.promisify()`]: util.html#util_util_promisify_original
+[`util.promisify()`]: util.md#util_util_promisify_original
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
@@ -3273,9 +3273,9 @@ introducing security vulnerabilities into an application.
 [`Buffer.from(string)`]: #buffer_static_method_buffer_from_string_encoding
 [`Buffer.poolSize`]: #buffer_class_property_buffer_poolsize
 [`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView
-[`ERR_INVALID_BUFFER_SIZE`]: errors.html#ERR_INVALID_BUFFER_SIZE
-[`ERR_INVALID_OPT_VALUE`]: errors.html#ERR_INVALID_OPT_VALUE
-[`ERR_OUT_OF_RANGE`]: errors.html#ERR_OUT_OF_RANGE
+[`ERR_INVALID_BUFFER_SIZE`]: errors.md#ERR_INVALID_BUFFER_SIZE
+[`ERR_INVALID_OPT_VALUE`]: errors.md#ERR_INVALID_OPT_VALUE
+[`ERR_OUT_OF_RANGE`]: errors.md#ERR_OUT_OF_RANGE
 [`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
 [`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer
 [`String#indexOf()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf
@@ -3300,7 +3300,7 @@ introducing security vulnerabilities into an application.
 [`buffer.constants.MAX_LENGTH`]: #buffer_buffer_constants_max_length
 [`buffer.constants.MAX_STRING_LENGTH`]: #buffer_buffer_constants_max_string_length
 [`buffer.kMaxLength`]: #buffer_buffer_kmaxlength
-[`util.inspect()`]: util.html#util_util_inspect_object_options
+[`util.inspect()`]: util.md#util_util_inspect_object_options
 [ASCII]: https://en.wikipedia.org/wiki/ASCII
 [Base64]: https://en.wikipedia.org/wiki/Base64
 [ISO-8859-1]: https://en.wikipedia.org/wiki/ISO-8859-1

diff --git a/doc/api/child_process.md b/doc/api/child_process.md
@@ -1580,13 +1580,13 @@ Therefore, this feature requires opting in by setting the
 or [`child_process.fork()`][].
 
 [Advanced serialization]: #child_process_advanced_serialization
-[`'disconnect'`]: process.html#process_event_disconnect
+[`'disconnect'`]: process.md#process_event_disconnect
 [`'error'`]: #child_process_event_error
 [`'exit'`]: #child_process_event_exit
-[`'message'`]: process.html#process_event_message
+[`'message'`]: process.md#process_event_message
 [`ChildProcess`]: #child_process_child_process
-[`Error`]: errors.html#errors_class_error
-[`EventEmitter`]: events.html#events_class_eventemitter
+[`Error`]: errors.md#errors_class_error
+[`EventEmitter`]: events.md#events_class_eventemitter
 [`child_process.exec()`]: #child_process_child_process_exec_command_options_callback
 [`child_process.execFile()`]: #child_process_child_process_execfile_file_args_options_callback
 [`child_process.execFileSync()`]: #child_process_child_process_execfilesync_file_args_options
@@ -1595,13 +1595,13 @@ or [`child_process.fork()`][].
 [`child_process.spawn()`]: #child_process_child_process_spawn_command_args_options
 [`child_process.spawnSync()`]: #child_process_child_process_spawnsync_command_args_options
 [`maxBuffer` and Unicode]: #child_process_maxbuffer_and_unicode
-[`net.Server`]: net.html#net_class_net_server
-[`net.Socket`]: net.html#net_class_net_socket
+[`net.Server`]: net.md#net_class_net_server
+[`net.Socket`]: net.md#net_class_net_socket
 [`options.detached`]: #child_process_options_detached
-[`process.disconnect()`]: process.html#process_process_disconnect
-[`process.env`]: process.html#process_process_env
-[`process.execPath`]: process.html#process_process_execpath
-[`process.send()`]: process.html#process_process_send_message_sendhandle_options_callback
+[`process.disconnect()`]: process.md#process_process_disconnect
+[`process.env`]: process.md#process_process_env
+[`process.execPath`]: process.md#process_process_execpath
+[`process.send()`]: process.md#process_process_send_message_sendhandle_options_callback
 [`stdio`]: #child_process_options_stdio
 [`subprocess.connected`]: #child_process_subprocess_connected
 [`subprocess.disconnect()`]: #child_process_subprocess_disconnect
@@ -1611,9 +1611,9 @@ or [`child_process.fork()`][].
 [`subprocess.stdin`]: #child_process_subprocess_stdin
 [`subprocess.stdio`]: #child_process_subprocess_stdio
 [`subprocess.stdout`]: #child_process_subprocess_stdout
-[`util.promisify()`]: util.html#util_util_promisify_original
+[`util.promisify()`]: util.md#util_util_promisify_original
 [Default Windows shell]: #child_process_default_windows_shell
 [HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
 [Shell requirements]: #child_process_shell_requirements
 [synchronous counterparts]: #child_process_synchronous_process_creation
-[v8.serdes]: v8.html#v8_serialization_api
+[v8.serdes]: v8.md#v8_serialization_api
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -1554,27 +1554,27 @@ $ node --max-old-space-size=1536 index.js
 ```
 
 [Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/
-[REPL]: repl.html
+[REPL]: repl.md
 [ScriptCoverage]: https://chromedevtools.github.io/devtools-protocol/tot/Profiler#type-ScriptCoverage
 [Source Map]: https://sourcemaps.info/spec.html
 [Subresource Integrity]: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity
 [V8 JavaScript code coverage]: https://v8project.blogspot.com/2017/12/javascript-code-coverage.html
 [`--openssl-config`]: #cli_openssl_config_file
 [`Atomics.wait()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Atomics/wait
-[`Buffer`]: buffer.html#buffer_class_buffer
+[`Buffer`]: buffer.md#buffer_class_buffer
 [`NODE_OPTIONS`]: #cli_node_options_options
-[`SlowBuffer`]: buffer.html#buffer_class_slowbuffer
-[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
-[`tls.DEFAULT_MAX_VERSION`]: tls.html#tls_tls_default_max_version
-[`tls.DEFAULT_MIN_VERSION`]: tls.html#tls_tls_default_min_version
-[`unhandledRejection`]: process.html#process_event_unhandledrejection
-[`worker_threads.threadId`]: worker_threads.html#worker_threads_worker_threadid
-[context-aware]: addons.html#addons_context_aware_addons
-[customizing ESM specifier resolution]: esm.html#esm_customizing_esm_specifier_resolution_algorithm
-[debugger]: debugger.html
+[`SlowBuffer`]: buffer.md#buffer_class_slowbuffer
+[`process.setUncaughtExceptionCaptureCallback()`]: process.md#process_process_setuncaughtexceptioncapturecallback_fn
+[`tls.DEFAULT_MAX_VERSION`]: tls.md#tls_tls_default_max_version
+[`tls.DEFAULT_MIN_VERSION`]: tls.md#tls_tls_default_min_version
+[`unhandledRejection`]: process.md#process_event_unhandledrejection
+[`worker_threads.threadId`]: worker_threads.md#worker_threads_worker_threadid
+[context-aware]: addons.md#addons_context_aware_addons
+[customizing ESM specifier resolution]: esm.md#esm_customizing_esm_specifier_resolution_algorithm
+[debugger]: debugger.md
 [debugging security implications]: https://nodejs.org/en/docs/guides/debugging-getting-started/#security-implications
-[emit_warning]: process.html#process_process_emitwarning_warning_type_code_ctor
-[experimental ECMAScript Module loader]: esm.html#esm_experimental_loaders
+[emit_warning]: process.md#process_process_emitwarning_warning_type_code_ctor
+[experimental ECMAScript Module loader]: esm.md#esm_experimental_loaders
 [jitless]: https://v8.dev/blog/jitless
 [libuv threadpool documentation]: https://docs.libuv.org/en/latest/threadpool.html
 [remote code execution]: https://www.owasp.org/index.php/Code_Injection
diff --git a/doc/api/cluster.md b/doc/api/cluster.md
@@ -875,15 +875,15 @@ socket.on('data', (id) => {
 
 [`.fork()`]: #cluster_cluster_fork_env
 [`.setupMaster()`]: #cluster_cluster_setupmaster_settings
-[`ChildProcess.send()`]: child_process.html#child_process_subprocess_send_message_sendhandle_options_callback
-[`child_process.fork()`]: child_process.html#child_process_child_process_fork_modulepath_args_options
-[`child_process` event: `'exit'`]: child_process.html#child_process_event_exit
-[`child_process` event: `'message'`]: child_process.html#child_process_event_message
+[`ChildProcess.send()`]: child_process.md#child_process_subprocess_send_message_sendhandle_options_callback
+[`child_process.fork()`]: child_process.md#child_process_child_process_fork_modulepath_args_options
+[`child_process` event: `'exit'`]: child_process.md#child_process_event_exit
+[`child_process` event: `'message'`]: child_process.md#child_process_event_message
 [`cluster.settings`]: #cluster_cluster_settings
-[`disconnect()`]: child_process.html#child_process_subprocess_disconnect
-[`kill()`]: process.html#process_process_kill_pid_signal
-[`process` event: `'message'`]: process.html#process_event_message
-[`server.close()`]: net.html#net_event_close
+[`disconnect()`]: child_process.md#child_process_subprocess_disconnect
+[`kill()`]: process.md#process_process_kill_pid_signal
+[`process` event: `'message'`]: process.md#process_event_message
+[`server.close()`]: net.md#net_event_close
 [`worker.exitedAfterDisconnect`]: #cluster_worker_exitedafterdisconnect
-[Advanced serialization for `child_process`]: child_process.html#child_process_advanced_serialization
-[Child Process module]: child_process.html#child_process_child_process_fork_modulepath_args_options
+[Advanced serialization for `child_process`]: child_process.md#child_process_advanced_serialization
+[Child Process module]: child_process.md#child_process_child_process_fork_modulepath_args_options
diff --git a/doc/api/console.md b/doc/api/console.md
@@ -554,12 +554,12 @@ This method does not display anything unless used in the inspector. The
 [`console.profileEnd()`]: #console_console_profileend_label
 [`console.time()`]: #console_console_time_label
 [`console.timeEnd()`]: #console_console_timeend_label
-[`process.stderr`]: process.html#process_process_stderr
-[`process.stdout`]: process.html#process_process_stdout
-[`util.format()`]: util.html#util_util_format_format_args
-[`util.inspect()`]: util.html#util_util_inspect_object_options
-[customizing `util.inspect()` colors]: util.html#util_customizing_util_inspect_colors
+[`process.stderr`]: process.md#process_process_stderr
+[`process.stdout`]: process.md#process_process_stdout
+[`util.format()`]: util.md#util_util_format_format_args
+[`util.inspect()`]: util.md#util_util_inspect_object_options
+[customizing `util.inspect()` colors]: util.md#util_customizing_util_inspect_colors
 [falsy]: https://developer.mozilla.org/en-US/docs/Glossary/Falsy
-[inspector]: debugger.html
-[note on process I/O]: process.html#process_a_note_on_process_i_o
+[inspector]: debugger.md
+[note on process I/O]: process.md#process_a_note_on_process_i_o
 [truthy]: https://developer.mozilla.org/en-US/docs/Glossary/Truthy
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
@@ -3544,11 +3544,11 @@ See the [list of SSL OP Flags][] for details.
   </tr>
 </table>
 
-[`Buffer`]: buffer.html
+[`Buffer`]: buffer.md
 [`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html
 [`KeyObject`]: #crypto_class_keyobject
 [`Sign`]: #crypto_class_sign
-[`UV_THREADPOOL_SIZE`]: cli.html#cli_uv_threadpool_size_size
+[`UV_THREADPOOL_SIZE`]: cli.md#cli_uv_threadpool_size_size
 [`Verify`]: #crypto_class_verify
 [`cipher.final()`]: #crypto_cipher_final_outputencoding
 [`cipher.update()`]: #crypto_cipher_update_data_inputencoding_outputencoding
@@ -3586,12 +3586,12 @@ See the [list of SSL OP Flags][] for details.
 [`hmac.digest()`]: #crypto_hmac_digest_encoding
 [`hmac.update()`]: #crypto_hmac_update_data_inputencoding
 [`keyObject.export()`]: #crypto_keyobject_export_options
-[`postMessage()`]: worker_threads.html#worker_threads_port_postmessage_value_transferlist
+[`postMessage()`]: worker_threads.md#worker_threads_port_postmessage_value_transferlist
 [`sign.sign()`]: #crypto_sign_sign_privatekey_outputencoding
 [`sign.update()`]: #crypto_sign_update_data_inputencoding
-[`stream.Writable` options]: stream.html#stream_new_stream_writable_options
-[`stream.transform` options]: stream.html#stream_new_stream_transform_options
-[`util.promisify()`]: util.html#util_util_promisify_original
+[`stream.Writable` options]: stream.md#stream_new_stream_writable_options
+[`stream.transform` options]: stream.md#stream_new_stream_transform_options
+[`util.promisify()`]: util.md#util_util_promisify_original
 [`verify.update()`]: #crypto_verify_update_data_inputencoding
 [`verify.verify()`]: #crypto_verify_verify_object_signature_signatureencoding
 [AEAD algorithms]: https://en.wikipedia.org/wiki/Authenticated_encryption
@@ -3612,10 +3612,10 @@ See the [list of SSL OP Flags][] for details.
 [RFC 3610]: https://www.rfc-editor.org/rfc/rfc3610.txt
 [RFC 4055]: https://www.rfc-editor.org/rfc/rfc4055.txt
 [RFC 5208]: https://www.rfc-editor.org/rfc/rfc5208.txt
-[encoding]: buffer.html#buffer_buffers_and_character_encodings
+[encoding]: buffer.md#buffer_buffers_and_character_encodings
 [initialization vector]: https://en.wikipedia.org/wiki/Initialization_vector
 [list of SSL OP Flags]: https://wiki.openssl.org/index.php/List_of_SSL_OP_Flags#Table_of_Options
 [safe integers]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger
 [scrypt]: https://en.wikipedia.org/wiki/Scrypt
-[stream]: stream.html
-[stream-writable-write]: stream.html#stream_writable_write_chunk_encoding_callback
+[stream]: stream.md
+[stream-writable-write]: stream.md#stream_writable_write_chunk_encoding_callback
diff --git a/doc/api/debugger.md b/doc/api/debugger.md
@@ -201,5 +201,5 @@ Chrome DevTools doesn't support debugging [worker threads][] yet.
 
 [Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/
 [V8 Inspector]: #debugger_v8_inspector_integration_for_node_js
-[worker threads]: worker_threads.html
+[worker threads]: worker_threads.md
 [ndb]: https://github.com/GoogleChromeLabs/ndb/