diff options
author | foxxyz <foxxyz@gmail.com> | 2021-07-05 06:39:17 +0300 |
---|---|---|
committer | Antoine du Hamel <duhamelantoine1995@gmail.com> | 2021-08-30 01:40:20 +0300 |
commit | 6fdd5827f0956ffc4e7ffe31babaf530e42f75b9 (patch) | |
tree | 1e0ccc64f99d288e3ed80119c53a1aac1c33348e /doc/api/v8.md | |
parent | b6b638bdd69e4bd07140497c026cdf0aba8dd544 (diff) |
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>
Diffstat (limited to 'doc/api/v8.md')
-rw-r--r-- | doc/api/v8.md | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/api/v8.md b/doc/api/v8.md index cdba51d8ddb..f94231451a5 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -545,22 +545,22 @@ A subclass of [`Deserializer`][] corresponding to the format written by [HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm [V8]: https://developers.google.com/v8/ [`Buffer`]: buffer.md -[`DefaultDeserializer`]: #v8_class_v8_defaultdeserializer -[`DefaultSerializer`]: #v8_class_v8_defaultserializer -[`Deserializer`]: #v8_class_v8_deserializer -[`Error`]: errors.md#errors_class_error +[`DefaultDeserializer`]: #class-v8defaultdeserializer +[`DefaultSerializer`]: #class-v8defaultserializer +[`Deserializer`]: #class-v8deserializer +[`Error`]: errors.md#class-error [`GetHeapSpaceStatistics`]: https://v8docs.nodesource.com/node-13.2/d5/dda/classv8_1_1_isolate.html#ac673576f24fdc7a33378f8f57e1d13a4 -[`NODE_V8_COVERAGE`]: cli.md#cli_node_v8_coverage_dir -[`Serializer`]: #v8_class_v8_serializer -[`deserializer._readHostObject()`]: #v8_deserializer_readhostobject -[`deserializer.transferArrayBuffer()`]: #v8_deserializer_transferarraybuffer_id_arraybuffer -[`serialize()`]: #v8_v8_serialize_value -[`serializer._getSharedArrayBufferId()`]: #v8_serializer_getsharedarraybufferid_sharedarraybuffer -[`serializer._writeHostObject()`]: #v8_serializer_writehostobject_object -[`serializer.releaseBuffer()`]: #v8_serializer_releasebuffer -[`serializer.transferArrayBuffer()`]: #v8_serializer_transferarraybuffer_id_arraybuffer -[`serializer.writeRawBytes()`]: #v8_serializer_writerawbytes_buffer -[`v8.stopCoverage()`]: #v8_v8_stopcoverage -[`v8.takeCoverage()`]: #v8_v8_takecoverage -[`vm.Script`]: vm.md#vm_new_vm_script_code_options +[`NODE_V8_COVERAGE`]: cli.md#node_v8_coveragedir +[`Serializer`]: #class-v8serializer +[`deserializer._readHostObject()`]: #deserializer_readhostobject +[`deserializer.transferArrayBuffer()`]: #deserializertransferarraybufferid-arraybuffer +[`serialize()`]: #v8serializevalue +[`serializer._getSharedArrayBufferId()`]: #serializer_getsharedarraybufferidsharedarraybuffer +[`serializer._writeHostObject()`]: #serializer_writehostobjectobject +[`serializer.releaseBuffer()`]: #serializerreleasebuffer +[`serializer.transferArrayBuffer()`]: #serializertransferarraybufferid-arraybuffer +[`serializer.writeRawBytes()`]: #serializerwriterawbytesbuffer +[`v8.stopCoverage()`]: #v8stopcoverage +[`v8.takeCoverage()`]: #v8takecoverage +[`vm.Script`]: vm.md#new-vmscriptcode-options [worker threads]: worker_threads.md |