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/readline.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/readline.md')
| -rw-r--r-- | doc/api/readline.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md index a22939d869d..8f056c942e3 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -969,16 +969,16 @@ const { createInterface } = require('readline'); </tr> </table> -[Readable]: stream.md#stream_readable_streams +[Readable]: stream.md#readable-streams [TTY]: tty.md -[TTY keybindings]: #readline_tty_keybindings -[Writable]: stream.md#stream_writable_streams -[`'SIGCONT'`]: #readline_event_sigcont -[`'SIGTSTP'`]: #readline_event_sigtstp -[`'line'`]: #readline_event_line -[`fs.ReadStream`]: fs.md#fs_class_fs_readstream -[`process.stdin`]: process.md#process_process_stdin -[`process.stdout`]: process.md#process_process_stdout -[`rl.close()`]: #readline_rl_close -[`unref()`]: net.md#net_socket_unref -[reading files]: #readline_example_read_file_stream_line_by_line +[TTY keybindings]: #tty-keybindings +[Writable]: stream.md#writable-streams +[`'SIGCONT'`]: #event-sigcont +[`'SIGTSTP'`]: #event-sigtstp +[`'line'`]: #event-line +[`fs.ReadStream`]: fs.md#class-fsreadstream +[`process.stdin`]: process.md#processstdin +[`process.stdout`]: process.md#processstdout +[`rl.close()`]: #rlclose +[`unref()`]: net.md#socketunref +[reading files]: #example-read-file-stream-line-by-line |