{"id":13563035,"url":"https://github.com/nhn/tui.jsdoc-template","last_synced_at":"2025-06-19T12:33:11.635Z","repository":{"id":47275906,"uuid":"73046302","full_name":"nhn/tui.jsdoc-template","owner":"nhn","description":"TUI JSDoc Template, Demo: https://nhnent.github.io/tui.jsdoc-template/latest/","archived":false,"fork":false,"pushed_at":"2023-04-17T16:10:21.000Z","size":852,"stargazers_count":177,"open_issues_count":27,"forks_count":53,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-05-17T09:42:18.211Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nhn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-11-07T05:50:08.000Z","updated_at":"2024-03-19T12:04:01.000Z","dependencies_parsed_at":"2024-01-19T07:09:21.908Z","dependency_job_id":"33176318-ff40-4cd4-9a07-ec5005f42b08","html_url":"https://github.com/nhn/tui.jsdoc-template","commit_stats":null,"previous_names":["nhnent/tui.jsdoc-template"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhn%2Ftui.jsdoc-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhn%2Ftui.jsdoc-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhn%2Ftui.jsdoc-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhn%2Ftui.jsdoc-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nhn","download_url":"https://codeload.github.com/nhn/tui.jsdoc-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243815924,"owners_count":20352248,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:01:14.507Z","updated_at":"2025-04-03T19:32:11.211Z","avatar_url":"https://github.com/nhn.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# TUI JSDoc Template\nToast UI JSDoc template\n\nDemo: https://nhnent.github.io/tui.jsdoc-template/latest/\n\n## Install\n\n```\nnpm i -D tui-jsdoc-template\n```\n\n## Feature\n\nTUI JSDoc template has the following features:\n\n* Navigation:\n  * AutoComplete Searchbox\n  * Collapsible\n  * Members / Methods / Events\n  * API / Examples (Tutorials) switcher\n  * Resizable\n* Examples: HTML/JS source tab in example pages\n\n![Example](https://cloud.githubusercontent.com/assets/12269563/20049432/69d2ed42-a506-11e6-980e-53b991e5ee5b.png)\n\n## Configuration\n\n([*jsdoc page - configuration*](http://usejsdoc.org/about-configuring-jsdoc.html#incorporating-command-line-options-into-the-configuration-file))\n\n### Template\n\n```\n\"opts\": {\n    \"template\": \"node_modules/tui-jsdoc-template\"\n}\n```\n\n### Logo\n\n```\n\"templates\": {\n    \"logo\": {\n        \"url\": \"http://nhnent.github.io/tui.component.tree/latest/styles/logo.png\",\n        \"width\": \"150px\",\n        \"height\": \"13px\",\n        \"link\": \"https://github.com/nhnent/tui.jsdoc-template\"\n    }\n}\n```\n\n### Page title\n\n```\n\"templates\": {\n    \"name\": \"Tui JSDoc Template\"\n}\n```\n\n### Footer text\n\n```\n\"templates\": {\n    \"footerText\": \"My awesome footer text\"\n}\n```\n\n### Use collapsible api list\n\n*Default: `true`*\n```\n\"templates\": {\n    \"useCollapsibles\": true\n}\n```\n\n### Tab Names\n\n```\n\"templates\": {\n    \"tabNames\": {\n        \"api\": \"API\",\n        \"tutorials\": \"Examples\"\n    }\n}\n```\n\n`api` defaults to the value `API` and `tutorials` defaults to the value `Examples`.\n\n### Custom Styles\n\nWith a folder structure like this:\n```\nstatic\n└── styles\n    └── custom.css\n    └── another.css\n```\nAnd a config like this:\n```js\n\"templates\": {\n    \"default\": {\n        \"staticFiles\": {\n            \"include\": [\"static/\"]\n        }\n    },\n    \"css\": [\n        \"styles/custom.css\",\n        \"styles/another.css\",\n        \"http://example.com/remote.css\"\n    ]\n}\n```\n\n`styles/custom.css`, `styles/another.css`, and `remote.css` get included in the layout.\n`default.staticFiles` is the build-in jsdoc way of copying extra files.\n\n## Expose the html/js code to example page\n\nIf `script` or `div` elements have `code-js` or `code-html` class, expose their innerHTML.\n\n1. innerHTML of `script.code-js` tag\n2. innerHTML of `div.code-html` tag\n\n```\n\u003c!DOCTYPE html\u003e\n\u003chtml lang=\"en\"\u003e\n\u003chead\u003e\n    \u003cmeta charset=\"UTF-8\"\u003e\n    \u003ctitle\u003eexample\u003c/title\u003e\n\u003c/head\u003e\n\u003cbody\u003e\n    \u003cdiv class=\"code-html\"\u003e\n        \u003ch3\u003e Base Example \u003c/h3\u003e\n        \u003cp\u003e Hello world \u003c/p\u003e\n    \u003c/div\u003e\n\n    \u003cscript class=\"code-js\"\u003e\n        console.log('hello world');\n    \u003c/script\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n\n```\n\n## Development\n\n1. Use `npm run serve` or `gulp serve` command to ascertain realtime.\n3. Api-Example tab, Auto-Complete and Resize functions are written in the `static/scripts/tui-doc.js` file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhn%2Ftui.jsdoc-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhn%2Ftui.jsdoc-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhn%2Ftui.jsdoc-template/lists"}