# tui-jsdoc-template
> Toast UI JSDoc Template
Latest version **1.2.2** (published 2017-07-31) · MIT license · 0 weekly downloads
## Install
```sh
npm install tui-jsdoc-template
pnpm add tui-jsdoc-template
yarn add tui-jsdoc-template
bun add tui-jsdoc-template
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.2.2 |
| Published | 2017-07-31 |
| First published | 2016-11-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 182 |
| Maintainers | minkyu-yi, nhnent |
| Keywords | jsdoc, jsdoc3, jsdoc-template, template, tui |
## Links
- npm: https://www.npmjs.com/package/tui-jsdoc-template
- Repository: https://github.com/nhnent/tui.jsdoc-template
- Homepage: https://github.com/nhnent/tui.jsdoc-template#readme
- Issues: https://github.com/nhnent/tui.jsdoc-template/issues
- npm.io page: https://npm.io/package/tui-jsdoc-template
## Dependencies (1)
- [cheerio](https://npm.io/package/cheerio.md) ^0.22.0
## Recent versions
- 1.2.2 (latest) — 2017-07-31
- 1.2.1 — 2017-07-31
- 1.2.0 — 2017-07-25
- 1.1.0 — 2017-01-21
- 1.0.6 — 2017-01-10
- 1.0.5 — 2016-12-18
- 1.0.4 — 2016-11-11
- 1.0.3 — 2016-11-09
- 1.0.1 — 2016-11-07
## README
# TUI JSDoc Template
Toast UI JSDoc template
Demo: https://nhnent.github.io/tui.jsdoc-template/latest/
## Install
```
npm i -D tui-jsdoc-template
```
## 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*](http://usejsdoc.org/about-configuring-jsdoc.html#incorporating-command-line-options-into-the-configuration-file))
### Template
```
"opts": {
"template": "node_modules/tui-jsdoc-template"
}
```
### Logo
```
"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"
}
}
```
### Page title
```
"templates": {
"name": "Tui JSDoc Template"
}
```
### Footer text
```
"templates": {
"footerText": "My awesome footer text"
}
```
### Use collapsible api list
*Default: `true`*
```
"templates": {
"useCollapsibles": ture
}
```
### Tab Names
```
"templates": {
"tabNames": {
"api": "API",
"tutorials": "Examples"
}
}
```
`api` defaults to the value `API` and `tutorials` defaults to the value `Examples`.
### Custom Styles
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
```
example
```
## 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.
---
_Source: https://npm.io/package/tui-jsdoc-template · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._