CPB JSDoc Template

CPB JSDoc template

Install

``
npm i -D https://github.com/nishikawa7863/cpb-jsdoc-template.git
`

Feature

TUI JSDoc template has the following features:

* Navigation:
* AutoComplete Searchbox
* Collapsible
* Members / Methods / Events
* API / Examples (Tutorials) switcher
* Resizable
* Examples: HTML/JS source tab in example pages

Configuration

(jsdoc page - configuration)

$3

`
"opts": {
"template": "node_modules/tui-jsdoc-template"
}
`

$3

`
"templates": {
"logo": {
"url": "http://nhnent.github.io/tui.component.tree/latest/styles/logo.png",
"width": "150px",
"height": "13px",
"link": "https://github.com/nhnent/tui.jsdoc-template"
}
}
`

$3

`
"templates": {
"name": "Tui JSDoc Template"
}
`

$3

`
"templates": {
"footerText": "My awesome footer text"
}
`

$3

Default: true
`
"templates": {
"useCollapsibles": true
}
`

$3

`
"templates": {
"tabNames": {
"api": "API",
"tutorials": "Examples"
}
}
`

api defaults to the value API and tutorials defaults to the value Examples.

$3

With a folder structure like this:
`
static
└── styles
└── custom.css
└── another.css
`
And a config like this:
`js
"templates": {
"default": {
"staticFiles": {
"include": ["static/"]
}
},
"css": [
"styles/custom.css",
"styles/another.css",
"http://example.com/remote.css"
]
}
`

styles/custom.css, styles/another.css, and remote.css get included in the layout.
default.staticFiles is the build-in jsdoc way of copying extra files.

Expose the html/js code to exmaple page

If script or div elements have code-js or code-html class, expose their innerHTML.

1. innerHTML of script.code-js tag
2. innerHTML of div.code-html tag

`













`

Development

1. Use npm run serve or gulp serve command to ascertain realtime.
3. Api-Example tab, Auto-Complete and Resize functions are written in the static/scripts/tui-doc.js` file.