Skip to content
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.

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

Can show whole tutorial tree #33

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
Can show whole tutorial tree
cag committed Sep 28, 2017
commit 95e7c7bf64c5389fa9550ecb28c538116c1fadba
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -67,7 +67,8 @@ In your `.jsdoc.json` file, add a template option.
"cleverLinks": false,
"monospaceLinks": true,
"useLongnameInNav": false,
"showInheritedInNav": true
"showInheritedInNav": true,
"showTutorialChildren": true
},
"opts": {
"destination": "./docs/",
97 changes: 56 additions & 41 deletions publish.js
Original file line number Diff line number Diff line change
@@ -369,63 +369,78 @@ function buildNav(members) {
}

function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {
var nav = []
if (items && items.length) {
var itemsNav = ""

nav.push(buildNavHeading(itemHeading))
nav.push(buildMemberNavList(items, itemsSeen, linktoFn, itemHeading === 'Tutorials').join(''))
}

return nav
}

function buildMemberNavList(items, itemsSeen, linktoFn, areTutorialLinks) {
var nav = []
var conf = env.conf.templates || {}

conf.default = conf.default || {}

if (items && items.length) {
var itemsNav = ""

nav.push(buildNavHeading(itemHeading))
items.forEach(function(item) {
var methods = find({ kind: "function", memberof: item.longname })
var members = find({ kind: "member", memberof: item.longname })
var displayName

if (!hasOwnProp.call(item, "longname")) {
nav.push(buildNavItem(linkfoFn('', item.name)))
return
}

items.forEach(function(item) {
var methods = find({ kind: "function", memberof: item.longname })
var members = find({ kind: "member", memberof: item.longname })
var displayName
if (!hasOwnProp.call(itemsSeen, item.longname)) {
if (!!conf.default.useLongnameInNav) {
displayName = item.longname

if (!hasOwnProp.call(item, "longname")) {
nav.push(buildNavItem(linkfoFn('', item.name)))
return
}

if (!hasOwnProp.call(itemsSeen, item.longname)) {
if (!!conf.default.useLongnameInNav) {
displayName = item.longname

if (conf.default.useLongnameInNav > 0 && conf.default.useLongnameInNav !== true) {
var num = conf.default.useLongnameInNav
var cropped = item.longname.split(".").slice(-num).join(".")
if (cropped !== displayName) {
displayName = "..." + cropped
}
if (conf.default.useLongnameInNav > 0 && conf.default.useLongnameInNav !== true) {
var num = conf.default.useLongnameInNav
var cropped = item.longname.split(".").slice(-num).join(".")
if (cropped !== displayName) {
displayName = "..." + cropped
}
} else {
displayName = item.name
}
} else {
displayName = item.name
}

displayName = displayName.replace(/^module:/g, "")

if (itemHeading === 'Tutorials') {
nav.push(buildNavItem(linktoFn(item.longname, displayName)))
} else {
nav.push(buildNavHeading(buildNavType(item.kind, linktoFn(item.longname, displayName))))
}
displayName = displayName.replace(/^module:/g, "")

if (methods.length) {
methods.forEach(function(method) {
if (method.inherited && conf.showInheritedInNav === false) {
return
}
if (areTutorialLinks) {
nav.push(buildNavItem(linktoFn(item.longname, displayName)))

nav.push(buildNavItem(buildNavType(method.kind, linkto(method.longname, method.name))))
})
if(conf.showTutorialChildren !== false && item.children && item.children.length) {
nav.push(
'<ol class="nav-tut-list">' +
buildMemberNavList(item.children, itemsSeen, linktoFn, areTutorialLinks).join('') +
'</ol>'
)
}
} else {
nav.push(buildNavHeading(buildNavType(item.kind, linktoFn(item.longname, displayName))))
}

itemsSeen[item.longname] = true
if (methods.length) {
methods.forEach(function(method) {
if (method.inherited && conf.showInheritedInNav === false) {
return
}

nav.push(buildNavItem(buildNavType(method.kind, linkto(method.longname, method.name))))
})
}
})
}

itemsSeen[item.longname] = true
}
})

return nav
}
5 changes: 5 additions & 0 deletions static/styles/jsdoc-default.css
Original file line number Diff line number Diff line change
@@ -262,6 +262,11 @@ nav li {
font-size: 13px;
}

.nav-tut-list {
margin: 0 0.5em;
padding: 0;
}

.type-function {
background: #B3E5FC;
color: #0288D1;