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/embedding.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/embedding.md')
| -rw-r--r-- | doc/api/embedding.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/embedding.md b/doc/api/embedding.md index 3c7cdd12f7c..b386772eb6c 100644 --- a/doc/api/embedding.md +++ b/doc/api/embedding.md @@ -159,7 +159,7 @@ int RunNodeInstance(MultiIsolatePlatform* platform, ``` [CLI options]: cli.md -[`process.memoryUsage()`]: process.md#process_process_memoryusage +[`process.memoryUsage()`]: process.md#processmemoryusage [deprecation policy]: deprecations.md [embedtest.cc]: https://github.com/nodejs/node/blob/HEAD/test/embedding/embedtest.cc [src/node.h]: https://github.com/nodejs/node/blob/HEAD/src/node.h |