Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

tui-jsdoc-template

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

tui-jsdoc-template

Toast UI JSDoc Template

  • 1.0.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
7.6K
increased by24.65%
Maintainers
1
Weekly downloads
 
Created
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.
  1. innerHTML of script.code-js tag
  2. 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.

FAQs

Package last updated on 07 Nov 2016

Did you know?

Socket

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

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc