Skip to content

Add a config option to remove the TOC (Table of Contents) #49

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

Open
evanplaice wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add a config option to remove the TOC (Table of Contents) #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c47efa1
Add a config option to remove the TOC
evanplaice Sep 14, 2019
4f37223
Move tocMarkdown declaration
evanplaice Sep 14, 2019
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
12 changes: 6 additions & 6 deletions bin/docdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ if (
'Usage:',
' docdown inputFile.js outputFile.md [options]',
'Options:',
' lang="js" The language indicator for code blocks.',
' sort=true|false Specify whether entries are sorted.',
' style="default|github" The hash style for links.',
' title="title" The documentation title.',
' toc="categories|properties" The table of contents organization style.',
' url="url" The source URL.'
' lang="js" The language indicator for code blocks.',
' sort=true|false Specify whether entries are sorted.',
' style="default|github" The hash style for links.',
' title="title" The documentation title.',
' toc="categories|properties|none" The table of contents organization style.',
' url="url" The source URL.'
].join('\n'));
process.exit(1);
}
Expand Down
106 changes: 57 additions & 49 deletions lib/generator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ function makeAnchor(href, text) {
*/
function generateDoc(source, options) {
var api = [],
noTOC = options.toc == 'none',
byCategories = options.toc == 'categories',
entries = getEntries(source),
organized = {},
Expand Down Expand Up @@ -294,57 +295,61 @@ function generateDoc(source, options) {
else {
tocGroups.sort(util.compareNatural);
}
// Start markdown for TOC categories.
var tocMarkdown = ['<!-- div class="toc-container" -->\n'];
_.each(tocGroups, function(group) {
tocMarkdown.push(
'<!-- div -->\n',
'## `' + group + '`'
);

if (sortEntries && organized[group]) {
// Sort the TOC groups.
organized[group].sort(function(value, other) {
var valMember = value.getMembers(0),
othMember = other.getMembers(0);

return util.compareNatural(
(valMember ? (valMember + getSeparator(value)) : '') + value.getName(),
(othMember ? (othMember + getSeparator(other)) : '') + other.getName()
);
});
}
// Add TOC entries for each category.
_.each(organized[group], function(entry) {
var member = entry.getMembers(0) || '',
name = entry.getName(),
sep = getSeparator(entry),
title = escape((member ? (member + sep) : '') + name);

if (entry.isAlias()) {
// An alias has a more complex html structure.
var owner = entry.getOwner();
tocMarkdown.push(
'* <a href="#' + owner.getHash(style) + '" class="alias">`' +
title + '` -> `' + owner.getName() + '`' +
'</a>'
);
} else {
// Add a simple TOC entry.
tocMarkdown.push(
'* ' +
makeAnchor(
'#' + entry.getHash(style),
'`' + title + '`'
)
);

var tocMarkdown = [];
if (!noTOC) {
// Start markdown for TOC categories.
tocMarkdown = ['<!-- div class="toc-container" -->\n'];
_.each(tocGroups, function(group) {
tocMarkdown.push(
'<!-- div -->\n',
'## `' + group + '`'
);

if (sortEntries && organized[group]) {
// Sort the TOC groups.
organized[group].sort(function(value, other) {
var valMember = value.getMembers(0),
othMember = other.getMembers(0);

return util.compareNatural(
(valMember ? (valMember + getSeparator(value)) : '') + value.getName(),
(othMember ? (othMember + getSeparator(other)) : '') + other.getName()
);
});
}
// Add TOC entries for each category.
_.each(organized[group], function(entry) {
var member = entry.getMembers(0) || '',
name = entry.getName(),
sep = getSeparator(entry),
title = escape((member ? (member + sep) : '') + name);

if (entry.isAlias()) {
// An alias has a more complex html structure.
var owner = entry.getOwner();
tocMarkdown.push(
'* <a href="#' + owner.getHash(style) + '" class="alias">`' +
title + '` -> `' + owner.getName() + '`' +
'</a>'
);
} else {
// Add a simple TOC entry.
tocMarkdown.push(
'* ' +
makeAnchor(
'#' + entry.getHash(style),
'`' + title + '`'
)
);
}
});
tocMarkdown.push('\n<!-- /div -->\n');
});
tocMarkdown.push('\n<!-- /div -->\n');
});

// End markdown for the TOC.
tocMarkdown.push('<!-- /div -->\n');
// End markdown for the TOC.
tocMarkdown.push('<!-- /div -->\n');
}

var docMarkdown = ['# '+ options.title + '\n'];
push.apply(docMarkdown, tocMarkdown);
Expand All @@ -355,7 +360,10 @@ function generateDoc(source, options) {
if (byCategories && !reSpecialCategory.test(group)) {
var groupName = '“' + group + '” Methods';
}
docMarkdown.push('## `' + (groupName || group) + '`');
if (!noTOC) {
docMarkdown.push('## `' + (groupName || group) + '`');
}

_.each(organized[group], function(entry) {
if (entry.markdown) {
docMarkdown.push(entry.markdown);
Expand Down