src_apidoc
Advanced tools
Readme
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:
"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.
If script or div elements have code-js or code-html class, expose their innerHTML.
script.code-js tagdiv.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>
npm run serve or gulp serve command to ascertain realtime.static/scripts/tui-doc.js file.FAQs
A UI JSDoc Template
We found that src_apidoc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.