tui-jsdoc-template

Toast UI JSDoc Template

1.0.3
Source
npm

Version published: 8 years ago

Weekly downloads: 7.6K; increased by24.65%

Maintainers: 1

Weekly downloads

Created: 8 years ago

Source

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)

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.

Keywords

FAQs

What is tui-jsdoc-template?

Is tui-jsdoc-template popular?

Is tui-jsdoc-template well maintained?

Package last updated on 09 Nov 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install