Package Exports

tui-jsdoc-template

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tui-jsdoc-template) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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 following features.

Navigation - AutoComplete Searchbox
Navigation - Members / Methods / Events
Navigation - API / Examples(Tutorials) Tab
Navigation - Resize
Examples - HTML/JS source tab in example page

Example

Configuration

(jsdoc page - configuration)

Template

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

Logo Image

"templates": {
    "logo": {
        "url": "http://nhnent.github.io/tui.component.tree/latest/styles/logo.png",
        "width": "150px",
        "height": "13px"
    }
}

Page Title

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

FooterText

"templates": {
    "footerText": "blabla..."
}

## Expose the html/js code to exmaple page If `script` or `div` elements have `code-js` or `code-html` class, expose their innerHTML.

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

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>example</title>
</head>
<body>
    <div class="code-html">
        <h3> Base Example </h3>
        <p> Hello world </p>
    </div>

    <script class="code-js">
        console.log('hello world');
    </script>
</body>
</html>

## 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.