0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 07:53:06 +01:00
nodejs/doc/api
Sakthipriyan Vairamani (thefourtheye) 5d0761f5f7
doc: do not link in the headings
If there is a link in the headings, when the ToC is generated, that is
not properly linked and the square brackets are left as they are.

Even if we fix this, different parts of the heading will link to
different sections or even different pages. For example,

    ### What makes [`Buffer.allocUnsafe()`] and
          [`Buffer.allocUnsafeSlow()`] "unsafe"?

will point to three different sections. `allocUnsafe` and
`allocUnsafeSlow` will link to their corresponding sections and all
other words actually link to the heading in the document. This could be
visually confusing.

PR-URL: https://github.com/nodejs/node/pull/9416
Fixes: https://github.com/nodejs/node/issues/9331

Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Brian White <mscdex@mscdex.net>
2016-11-05 15:14:51 +05:30
..
_toc.md
addons.md tools: enable more remark-lint rules 2016-09-25 13:02:45 +03:00
all.md
assert.md
buffer.md doc: do not link in the headings 2016-11-05 15:14:51 +05:30
child_process.md child_process: add public API for IPC channel 2016-11-01 20:37:57 -04:00
cli.md src: add NODE_PRESERVE_SYMLINKS environment variable 2016-10-24 22:13:08 +03:00
cluster.md doc: remove extra comma in cluster docs 2016-09-17 22:05:51 -04:00
console.md doc: standardize rest parameters 2016-09-14 08:08:28 +02:00
crypto.md doc: update OpenSSL links 2016-11-01 19:42:56 +01:00
debugger.md doc: change ./node to node in debugger.md 2016-10-06 23:45:12 +02:00
dgram.md
dns.md tools: enable more remark-lint rules 2016-09-25 13:02:45 +03:00
documentation.md
domain.md doc: standardize rest parameters 2016-09-14 08:08:28 +02:00
errors.md doc: specify that errno is a number, not a string 2016-10-16 20:43:21 +02:00
events.md doc: standardize rest parameters 2016-09-14 08:08:28 +02:00
fs.md doc: use 'an' over 'a', remove redundant sentence 2016-11-01 23:56:46 +01:00
globals.md doc: add performance warning to require.extensions 2016-10-24 22:50:41 +02:00
http.md doc: fix typo in http.md 2016-10-26 12:33:43 -07:00
https.md doc: update OpenSSL links 2016-11-01 19:42:56 +01:00
index.md
modules.md doc: clarify relation between a file and a module 2016-10-26 12:57:05 -07:00
net.md http: socket connection timeout for http request 2016-09-26 13:33:52 +03:00
os.md doc: fix typos 2016-09-02 23:49:54 +02:00
path.md doc: fix typo in path doc 2016-09-18 11:30:23 +02:00
process.md child_process: add public API for IPC channel 2016-11-01 20:37:57 -04:00
punycode.md
querystring.md
readline.md doc: remove duplicate content from readline doc 2016-09-15 08:31:09 +02:00
repl.md doc: fix typo in repl doc 2016-09-30 07:58:34 -07:00
stream.md doc: edit Stream api grammar 2016-10-17 09:05:42 -07:00
string_decoder.md
synopsis.md
timers.md doc: enable no-file-name-articles remark-lint rule 2016-09-27 07:07:40 -07:00
tls.md doc: update OpenSSL links 2016-11-01 19:42:56 +01:00
tty.md
url.md doc: fix markdown formatting in url.md 2016-10-05 11:36:03 -04:00
util.md doc: more realistic custom inspect example 2016-10-26 22:24:53 +02:00
v8.md
vm.md
zlib.md doc: move stray sentences in zlib doc 2016-11-01 22:08:41 -07:00