doc: anchor link parity between markdown and html-generated docs · nodejs/node@6fdd582 · GitHub
Skip to content

Commit 6fdd582

Browse files
foxxyzaduh95
foxxyz
authored and
aduh95
committed
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: #39304 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent b6b638b commit 6fdd582

59 files changed

Lines changed: 1499 additions & 1436 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/api/addons.md‎

Lines changed: 5 additions & 4 deletions

‎doc/api/assert.md‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ assert.deepEqual([[[1, 2, 3]], 4, 5], [[[1, 2, '3']], 4, 5]);
9999
To deactivate the colors, use the `NO_COLOR` or `NODE_DISABLE_COLORS`
100100
environment variables. This will also deactivate the colors in the REPL. For
101101
more on color support in terminal environments, read the tty
102-
[getColorDepth()](tty.md#tty_writestream_getcolordepth_env) documentation.
102+
[`getColorDepth()`][] documentation.
103103

104104
## Legacy assertion mode
105105

@@ -2420,34 +2420,35 @@ argument.
24202420
[Object.prototype.toString()]: https://tc39.github.io/ecma262/#sec-object.prototype.tostring
24212421
[SameValue Comparison]: https://tc39.github.io/ecma262/#sec-samevalue
24222422
[Strict Equality Comparison]: https://tc39.github.io/ecma262/#sec-strict-equality-comparison
2423-
[`AssertionError`]: #assert_class_assert_assertionerror
2424-
[`CallTracker`]: #assert_class_assert_calltracker
2423+
[`AssertionError`]: #class-assertassertionerror
2424+
[`CallTracker`]: #class-assertcalltracker
24252425
[`Class`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
2426-
[`ERR_INVALID_RETURN_VALUE`]: errors.md#errors_err_invalid_return_value
2427-
[`Error.captureStackTrace`]: errors.md#errors_error_capturestacktrace_targetobject_constructoropt
2428-
[`Error`]: errors.md#errors_class_error
2426+
[`ERR_INVALID_RETURN_VALUE`]: errors.md#err_invalid_return_value
2427+
[`Error.captureStackTrace`]: errors.md#errorcapturestacktracetargetobject-constructoropt
2428+
[`Error`]: errors.md#class-error
24292429
[`Map`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
24302430
[`Object.is()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is
24312431
[`RegExp`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
24322432
[`Set`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
24332433
[`Symbol`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol
2434-
[`TypeError`]: errors.md#errors_class_typeerror
2434+
[`TypeError`]: errors.md#class-typeerror
24352435
[`WeakMap`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
24362436
[`WeakSet`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet
2437-
[`assert.deepEqual()`]: #assert_assert_deepequal_actual_expected_message
2438-
[`assert.deepStrictEqual()`]: #assert_assert_deepstrictequal_actual_expected_message
2439-
[`assert.doesNotThrow()`]: #assert_assert_doesnotthrow_fn_error_message
2440-
[`assert.equal()`]: #assert_assert_equal_actual_expected_message
2441-
[`assert.notDeepEqual()`]: #assert_assert_notdeepequal_actual_expected_message
2442-
[`assert.notDeepStrictEqual()`]: #assert_assert_notdeepstrictequal_actual_expected_message
2443-
[`assert.notEqual()`]: #assert_assert_notequal_actual_expected_message
2444-
[`assert.notStrictEqual()`]: #assert_assert_notstrictequal_actual_expected_message
2445-
[`assert.ok()`]: #assert_assert_ok_value_message
2446-
[`assert.strictEqual()`]: #assert_assert_strictequal_actual_expected_message
2447-
[`assert.throws()`]: #assert_assert_throws_fn_error_message
2448-
[`process.on('exit')`]: process.md#process_event_exit
2449-
[`tracker.calls()`]: #assert_tracker_calls_fn_exact
2450-
[`tracker.verify()`]: #assert_tracker_verify
2437+
[`assert.deepEqual()`]: #assertdeepequalactual-expected-message
2438+
[`assert.deepStrictEqual()`]: #assertdeepstrictequalactual-expected-message
2439+
[`assert.doesNotThrow()`]: #assertdoesnotthrowfn-error-message
2440+
[`assert.equal()`]: #assertequalactual-expected-message
2441+
[`assert.notDeepEqual()`]: #assertnotdeepequalactual-expected-message
2442+
[`assert.notDeepStrictEqual()`]: #assertnotdeepstrictequalactual-expected-message
2443+
[`assert.notEqual()`]: #assertnotequalactual-expected-message
2444+
[`assert.notStrictEqual()`]: #assertnotstrictequalactual-expected-message
2445+
[`assert.ok()`]: #assertokvalue-message
2446+
[`assert.strictEqual()`]: #assertstrictequalactual-expected-message
2447+
[`assert.throws()`]: #assertthrowsfn-error-message
2448+
[`getColorDepth()`]: tty.md#writestreamgetcolordepthenv
2449+
[`process.on('exit')`]: process.md#event-exit
2450+
[`tracker.calls()`]: #trackercallsfn-exact
2451+
[`tracker.verify()`]: #trackerverify
24512452
[enumerable "own" properties]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties
24522453
[prototype-spec]: https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots
2453-
[strict assertion mode]: #assert_strict_assertion_mode
2454+
[strict assertion mode]: #strict-assertion-mode

‎doc/api/async_context.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -786,8 +786,8 @@ const server = createServer((req, res) => {
786786
}).listen(3000);
787787
```
788788
789-
[`AsyncResource`]: #async_context_class_asyncresource
790-
[`EventEmitter`]: events.md#events_class_eventemitter
791-
[`Stream`]: stream.md#stream_stream
792-
[`Worker`]: worker_threads.md#worker_threads_class_worker
793-
[`util.promisify()`]: util.md#util_util_promisify_original
789+
[`AsyncResource`]: #class-asyncresource
790+
[`EventEmitter`]: events.md#class-eventemitter
791+
[`Stream`]: stream.md#stream
792+
[`Worker`]: worker_threads.md#class-worker
793+
[`util.promisify()`]: util.md#utilpromisifyoriginal

‎doc/api/async_hooks.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -841,14 +841,14 @@ The documentation for this class has moved [`AsyncResource`][].
841841
842842
The documentation for this class has moved [`AsyncLocalStorage`][].
843843
844-
[Hook Callbacks]: #async_hooks_hook_callbacks
844+
[Hook Callbacks]: #hook-callbacks
845845
[PromiseHooks]: https://docs.google.com/document/d/1rda3yKGHimKIhg5YeoAmCOtyURgsbTH_qaYR79FELlk/edit
846-
[`AsyncLocalStorage`]: async_context.md#async_context_class_asynclocalstorage
847-
[`AsyncResource`]: async_context.md#async_context_class_asyncresource
848-
[`Worker`]: worker_threads.md#worker_threads_class_worker
849-
[`after` callback]: #async_hooks_after_asyncid
850-
[`before` callback]: #async_hooks_before_asyncid
851-
[`destroy` callback]: #async_hooks_destroy_asyncid
852-
[`init` callback]: #async_hooks_init_asyncid_type_triggerasyncid_resource
853-
[`promiseResolve` callback]: #async_hooks_promiseresolve_asyncid
854-
[promise execution tracking]: #async_hooks_promise_execution_tracking
846+
[`AsyncLocalStorage`]: async_context.md#class-asynclocalstorage
847+
[`AsyncResource`]: async_context.md#class-asyncresource
848+
[`Worker`]: worker_threads.md#class-worker
849+
[`after` callback]: #afterasyncid
850+
[`before` callback]: #beforeasyncid
851+
[`destroy` callback]: #destroyasyncid
852+
[`init` callback]: #initasyncid-type-triggerasyncid-resource
853+
[`promiseResolve` callback]: #promiseresolveasyncid
854+
[promise execution tracking]: #promise-execution-tracking

‎doc/api/buffer.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5199,19 +5199,19 @@ introducing security vulnerabilities into an application.
51995199
[WHATWG Encoding Standard]: https://encoding.spec.whatwg.org/
52005200
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
52015201
[`Blob`]: https://developer.mozilla.org/en-US/docs/Web/API/Blob
5202-
[`Buffer.alloc()`]: #buffer_static_method_buffer_alloc_size_fill_encoding
5203-
[`Buffer.allocUnsafe()`]: #buffer_static_method_buffer_allocunsafe_size
5204-
[`Buffer.allocUnsafeSlow()`]: #buffer_static_method_buffer_allocunsafeslow_size
5205-
[`Buffer.concat()`]: #buffer_static_method_buffer_concat_list_totallength
5206-
[`Buffer.from(array)`]: #buffer_static_method_buffer_from_array
5207-
[`Buffer.from(arrayBuf)`]: #buffer_static_method_buffer_from_arraybuffer_byteoffset_length
5208-
[`Buffer.from(buffer)`]: #buffer_static_method_buffer_from_buffer
5209-
[`Buffer.from(string)`]: #buffer_static_method_buffer_from_string_encoding
5210-
[`Buffer.poolSize`]: #buffer_class_property_buffer_poolsize
5202+
[`Buffer.alloc()`]: #static-method-bufferallocsize-fill-encoding
5203+
[`Buffer.allocUnsafe()`]: #static-method-bufferallocunsafesize
5204+
[`Buffer.allocUnsafeSlow()`]: #static-method-bufferallocunsafeslowsize
5205+
[`Buffer.concat()`]: #static-method-bufferconcatlist-totallength
5206+
[`Buffer.from(array)`]: #static-method-bufferfromarray
5207+
[`Buffer.from(arrayBuf)`]: #static-method-bufferfromarraybuffer-byteoffset-length
5208+
[`Buffer.from(buffer)`]: #static-method-bufferfrombuffer
5209+
[`Buffer.from(string)`]: #static-method-bufferfromstring-encoding
5210+
[`Buffer.poolSize`]: #class-property-bufferpoolsize
52115211
[`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView
5212-
[`ERR_INVALID_ARG_VALUE`]: errors.md#ERR_INVALID_ARG_VALUE
5213-
[`ERR_INVALID_BUFFER_SIZE`]: errors.md#ERR_INVALID_BUFFER_SIZE
5214-
[`ERR_OUT_OF_RANGE`]: errors.md#ERR_OUT_OF_RANGE
5212+
[`ERR_INVALID_ARG_VALUE`]: errors.md#err_invalid_arg_value
5213+
[`ERR_INVALID_BUFFER_SIZE`]: errors.md#err_invalid_buffer_size
5214+
[`ERR_OUT_OF_RANGE`]: errors.md#err_out_of_range
52155215
[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
52165216
[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer
52175217
[`String.prototype.indexOf()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf
@@ -5223,20 +5223,20 @@ introducing security vulnerabilities into an application.
52235223
[`TypedArray.prototype.subarray()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/subarray
52245224
[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
52255225
[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
5226-
[`buf.buffer`]: #buffer_buf_buffer
5227-
[`buf.compare()`]: #buffer_buf_compare_target_targetstart_targetend_sourcestart_sourceend
5228-
[`buf.entries()`]: #buffer_buf_entries
5229-
[`buf.fill()`]: #buffer_buf_fill_value_offset_end_encoding
5230-
[`buf.indexOf()`]: #buffer_buf_indexof_value_byteoffset_encoding
5231-
[`buf.keys()`]: #buffer_buf_keys
5232-
[`buf.length`]: #buffer_buf_length
5233-
[`buf.slice()`]: #buffer_buf_slice_start_end
5234-
[`buf.toString()`]: #buffer_buf_tostring_encoding_start_end
5235-
[`buf.values()`]: #buffer_buf_values
5236-
[`buffer.constants.MAX_LENGTH`]: #buffer_buffer_constants_max_length
5237-
[`buffer.constants.MAX_STRING_LENGTH`]: #buffer_buffer_constants_max_string_length
5238-
[`buffer.kMaxLength`]: #buffer_buffer_kmaxlength
5239-
[`util.inspect()`]: util.md#util_util_inspect_object_options
5226+
[`buf.buffer`]: #bufbuffer
5227+
[`buf.compare()`]: #bufcomparetarget-targetstart-targetend-sourcestart-sourceend
5228+
[`buf.entries()`]: #bufentries
5229+
[`buf.fill()`]: #buffillvalue-offset-end-encoding
5230+
[`buf.indexOf()`]: #bufindexofvalue-byteoffset-encoding
5231+
[`buf.keys()`]: #bufkeys
5232+
[`buf.length`]: #buflength
5233+
[`buf.slice()`]: #bufslicestart-end
5234+
[`buf.toString()`]: #buftostringencoding-start-end
5235+
[`buf.values()`]: #bufvalues
5236+
[`buffer.constants.MAX_LENGTH`]: #bufferconstantsmax_length
5237+
[`buffer.constants.MAX_STRING_LENGTH`]: #bufferconstantsmax_string_length
5238+
[`buffer.kMaxLength`]: #bufferkmaxlength
5239+
[`util.inspect()`]: util.md#utilinspectobject-options
52405240
[`v8::TypedArray::kMaxLength`]: https://v8.github.io/api/head/classv8_1_1TypedArray.html#a54a48f4373da0850663c4393d843b9b0
52415241
[base64url]: https://tools.ietf.org/html/rfc4648#section-5
52425242
[binary strings]: https://developer.mozilla.org/en-US/docs/Web/API/DOMString/Binary

‎doc/api/child_process.md‎

Lines changed: 38 additions & 38 deletions

0 commit comments

Comments
 (0)