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/https.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/https.md')
-rw-r--r-- | doc/api/https.md | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/doc/api/https.md b/doc/api/https.md index ff057d23e5c..98a845994a7 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -462,29 +462,29 @@ statusCode: 200 headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; pin-sha256="RRM1dGqnDFsCJXBTHky16vi1obOlCgFFn/yOhI/y+ho="; pin-sha256="k2v657xBsOVe1PQRwOsHsw3bsGT2VzIqz5K+59sNQws="; pin-sha256="K87oWBWM9UZfyddvDfoxL+8lpNyoUB2ptGtn0fv6G2Q="; pin-sha256="IQBnNBEiFuhj+8x6X8XLgh01V9Ic5/V3IRQLNFFc7v4="; pin-sha256="iie1VXtL7HzAMF+/PVPR9xzT80kQxdZeJ+zduCB3uj0="; pin-sha256="LvRiGEjRqfzurezaWuj8Wie2gyHMrW5Q06LspMnox7A="; includeSubDomains ``` -[`Agent`]: #https_class_https_agent -[`Session Resumption`]: tls.md#tls_session_resumption -[`URL`]: url.md#url_the_whatwg_url_api -[`http.Agent(options)`]: http.md#http_new_agent_options -[`http.Agent`]: http.md#http_class_http_agent -[`http.ClientRequest`]: http.md#http_class_http_clientrequest -[`http.Server#headersTimeout`]: http.md#http_server_headerstimeout -[`http.Server#keepAliveTimeout`]: http.md#http_server_keepalivetimeout -[`http.Server#maxHeadersCount`]: http.md#http_server_maxheaderscount -[`http.Server#requestTimeout`]: http.md#http_server_requesttimeout -[`http.Server#setTimeout()`]: http.md#http_server_settimeout_msecs_callback -[`http.Server#timeout`]: http.md#http_server_timeout -[`http.Server`]: http.md#http_class_http_server -[`http.close()`]: http.md#http_server_close_callback -[`http.createServer()`]: http.md#http_http_createserver_options_requestlistener -[`http.get()`]: http.md#http_http_get_options_callback -[`http.request()`]: http.md#http_http_request_options_callback -[`https.Agent`]: #https_class_https_agent -[`https.request()`]: #https_https_request_options_callback -[`net.Server`]: net.md#net_class_net_server -[`new URL()`]: url.md#url_new_url_input_base -[`server.listen()`]: net.md#net_server_listen -[`tls.connect()`]: tls.md#tls_tls_connect_options_callback -[`tls.createSecureContext()`]: tls.md#tls_tls_createsecurecontext_options -[`tls.createServer()`]: tls.md#tls_tls_createserver_options_secureconnectionlistener +[`Agent`]: #class-httpsagent +[`Session Resumption`]: tls.md#session-resumption +[`URL`]: url.md#the-whatwg-url-api +[`http.Agent(options)`]: http.md#new-agentoptions +[`http.Agent`]: http.md#class-httpagent +[`http.ClientRequest`]: http.md#class-httpclientrequest +[`http.Server#headersTimeout`]: http.md#serverheaderstimeout +[`http.Server#keepAliveTimeout`]: http.md#serverkeepalivetimeout +[`http.Server#maxHeadersCount`]: http.md#servermaxheaderscount +[`http.Server#requestTimeout`]: http.md#serverrequesttimeout +[`http.Server#setTimeout()`]: http.md#serversettimeoutmsecs-callback +[`http.Server#timeout`]: http.md#servertimeout +[`http.Server`]: http.md#class-httpserver +[`http.close()`]: http.md#serverclosecallback +[`http.createServer()`]: http.md#httpcreateserveroptions-requestlistener +[`http.get()`]: http.md#httpgetoptions-callback +[`http.request()`]: http.md#httprequestoptions-callback +[`https.Agent`]: #class-httpsagent +[`https.request()`]: #httpsrequestoptions-callback +[`net.Server`]: net.md#class-netserver +[`new URL()`]: url.md#new-urlinput-base +[`server.listen()`]: net.md#serverlisten +[`tls.connect()`]: tls.md#tlsconnectoptions-callback +[`tls.createSecureContext()`]: tls.md#tlscreatesecurecontextoptions +[`tls.createServer()`]: tls.md#tlscreateserveroptions-secureconnectionlistener [sni wiki]: https://en.wikipedia.org/wiki/Server_Name_Indication |