Skip to content

tools: add direct anchors for error codes #16779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
joyeecheung wants to merge 1 commit into from
Closed

tools: add direct anchors for error codes #16779

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
tools: add direct anchors for error codes 
This adds direct anchors for the error codes in errors.html.
For example, previously the anchor for ERR_ASSERTION
is #errors_err_assertion, now there is also #ERR_ASSERTION.
  • Loading branch information
@joyeecheung
joyeecheung committed Nov 8, 2017
commit 59efb26efaed959f8341a645857554d000166098
12 changes: 9 additions & 3 deletions tools/doc/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,9 @@ function getSection(lexed) {
return '';
}

function getMark(anchor) {
return `<span><a class="mark" href="#${anchor}" id="${anchor}">#</a></span>`;
}

function buildToc(lexed, filename, cb) {
var toc = [];
Expand Down Expand Up @@ -499,12 +502,15 @@ function buildToc(lexed, filename, cb) {

depth = tok.depth;
const realFilename = path.basename(realFilenames[0], '.md');
const id = getId(`${realFilename}_${tok.text.trim()}`);
const apiName = tok.text.trim();
const id = getId(`${realFilename}_${apiName}`);
toc.push(new Array((depth - 1) * 2 + 1).join(' ') +
`* <span class="stability_${tok.stability}">` +
`<a href="#${id}">${tok.text}</a></span>`);
tok.text += `<span><a class="mark" href="#${id}"` +
`id="${id}">#</a></span>`;
tok.text += getMark(id);
if (realFilename === 'errors' && apiName.startsWith('ERR_')) {
tok.text += getMark(apiName);
}
});

toc = marked.parse(toc.join('\n'));
Expand Down