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/dgram.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/dgram.md')
-rw-r--r-- | doc/api/dgram.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/api/dgram.md b/doc/api/dgram.md index 365c30c9ae6..da267926f37 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -912,19 +912,19 @@ and `udp6` sockets). The bound address and port can be retrieved using [IPv6 Zone Indices]: https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses [RFC 4007]: https://tools.ietf.org/html/rfc4007 -[`'close'`]: #dgram_event_close -[`ERR_SOCKET_BAD_PORT`]: errors.md#errors_err_socket_bad_port -[`ERR_SOCKET_BUFFER_SIZE`]: errors.md#errors_err_socket_buffer_size -[`ERR_SOCKET_DGRAM_IS_CONNECTED`]: errors.md#errors_err_socket_dgram_is_connected -[`ERR_SOCKET_DGRAM_NOT_CONNECTED`]: errors.md#errors_err_socket_dgram_not_connected -[`Error`]: errors.md#errors_class_error -[`System Error`]: errors.md#errors_class_systemerror -[`close()`]: #dgram_socket_close_callback +[`'close'`]: #event-close +[`ERR_SOCKET_BAD_PORT`]: errors.md#err_socket_bad_port +[`ERR_SOCKET_BUFFER_SIZE`]: errors.md#err_socket_buffer_size +[`ERR_SOCKET_DGRAM_IS_CONNECTED`]: errors.md#err_socket_dgram_is_connected +[`ERR_SOCKET_DGRAM_NOT_CONNECTED`]: errors.md#err_socket_dgram_not_connected +[`Error`]: errors.md#class-error +[`System Error`]: errors.md#class-systemerror +[`close()`]: #socketclosecallback [`cluster`]: cluster.md -[`connect()`]: #dgram_socket_connect_port_address_callback -[`dgram.createSocket()`]: #dgram_dgram_createsocket_options_callback -[`dns.lookup()`]: dns.md#dns_dns_lookup_hostname_options_callback -[`socket.address().address`]: #dgram_socket_address -[`socket.address().port`]: #dgram_socket_address -[`socket.bind()`]: #dgram_socket_bind_port_address_callback -[byte length]: buffer.md#buffer_static_method_buffer_bytelength_string_encoding +[`connect()`]: #socketconnectport-address-callback +[`dgram.createSocket()`]: #dgramcreatesocketoptions-callback +[`dns.lookup()`]: dns.md#dnslookuphostname-options-callback +[`socket.address().address`]: #socketaddress +[`socket.address().port`]: #socketaddress +[`socket.bind()`]: #socketbindport-address-callback +[byte length]: buffer.md#static-method-bufferbytelengthstring-encoding |