lukechilds/node - node - Gitea: Git with a cup of tea

History

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>		8 years ago
..
_toc.md	doc: subdivide TOC, add auxiliary links	9 years ago
addons.md	tools: enable more remark-lint rules	8 years ago
all.md	doc: git mv to .md	9 years ago
assert.md	doc: use blockquotes for Stability: markers	8 years ago
buffer.md	doc: do not link in the headings	8 years ago
child_process.md	child_process: add public API for IPC channel	8 years ago
cli.md	src: add NODE_PRESERVE_SYMLINKS environment variable	8 years ago
cluster.md	doc: remove extra comma in cluster docs	8 years ago
console.md	doc: standardize rest parameters	8 years ago
crypto.md	doc: update OpenSSL links	8 years ago
debugger.md	doc: change ./node to node in debugger.md	8 years ago
dgram.md	doc: fix broken link in dgram doc	8 years ago
dns.md	tools: enable more remark-lint rules	8 years ago
documentation.md	doc: use blockquotes for Stability: markers	8 years ago
domain.md	doc: standardize rest parameters	8 years ago
errors.md	doc: specify that errno is a number, not a string	8 years ago
events.md	doc: standardize rest parameters	8 years ago
fs.md	doc: use 'an' over 'a', remove redundant sentence	8 years ago
globals.md	doc: add performance warning to require.extensions	8 years ago
http.md	doc: fix typo in http.md	8 years ago
https.md	doc: update OpenSSL links	8 years ago
index.md	doc: git mv to .md	9 years ago
modules.md	doc: clarify relation between a file and a module	8 years ago
net.md	http: socket connection timeout for http request	8 years ago
os.md	doc: fix typos	8 years ago
path.md	doc: fix typo in path doc	8 years ago
process.md	child_process: add public API for IPC channel	8 years ago
punycode.md	doc: use blockquotes for Stability: markers	8 years ago
querystring.md	doc: fix "hashOwnProperty" typo in querystring	8 years ago
readline.md	doc: remove duplicate content from readline doc	8 years ago
repl.md	doc: fix typo in repl doc	8 years ago
stream.md	doc: edit Stream api grammar	8 years ago
string_decoder.md	doc: use blockquotes for Stability: markers	8 years ago
synopsis.md	doc: various documentation formatting fixes	8 years ago
timers.md	doc: enable no-file-name-articles remark-lint rule	8 years ago
tls.md	doc: update OpenSSL links	8 years ago
tty.md	doc: use blockquotes for Stability: markers	8 years ago
url.md	doc: fix markdown formatting in url.md	8 years ago
util.md	doc: more realistic custom inspect example	8 years ago
v8.md	doc: various documentation formatting fixes	8 years ago
vm.md	doc: fix typo in vm.runInNewContext() description	8 years ago
zlib.md	doc: move stray sentences in zlib doc	8 years ago