A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://github.com/nhnent/tui.jsdoc-template below:

nhn/tui.jsdoc-template: TUI JSDoc Template, Demo: https://nhnent.github.io/tui.jsdoc-template/latest/

Toast UI JSDoc template

Demo: https://nhnent.github.io/tui.jsdoc-template/latest/

npm i -D tui-jsdoc-template

TUI JSDoc template has the following features:

(jsdoc page - configuration)

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

"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"
    }
}

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

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

Default: true

"templates": {
    "useCollapsibles": true
}

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

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

With a folder structure like this:

static
└── styles
    └── custom.css
    └── another.css

And a config like this:

"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 example 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>
  1. Use npm run serve or gulp serve command to ascertain realtime.
  2. Api-Example tab, Auto-Complete and Resize functions are written in the static/scripts/tui-doc.js file.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4