Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nhn/tui.jsdoc-template

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

Last synced: 4 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/nhn/tui.jsdoc-template
Owner: nhn
License: mit
Created: 2016-11-07T05:50:08.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2023-04-17T16:10:21.000Z (almost 2 years ago)
Last Synced: 2024-05-17T09:42:18.211Z (9 months ago)
Language: JavaScript
Homepage:
Size: 832 KB
Stars: 177
Watchers: 13
Forks: 53
Open Issues: 27
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 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 the following features:

* Navigation:
* AutoComplete Searchbox
* Collapsible
* Members / Methods / Events
* API / Examples (Tutorials) switcher
* Resizable
* Examples: HTML/JS source tab in example pages

![Example](https://cloud.githubusercontent.com/assets/12269563/20049432/69d2ed42-a506-11e6-980e-53b991e5ee5b.png)

## Configuration

([*jsdoc page - configuration*](http://usejsdoc.org/about-configuring-jsdoc.html#incorporating-command-line-options-into-the-configuration-file))

### Template

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

### Logo

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

### Page title

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

### Footer text

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

### Use collapsible api list

*Default: `true`*
```
"templates": {
"useCollapsibles": true
}
```

### Tab Names

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

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

### Custom Styles

With a folder structure like this:
```
static
└── styles
└── custom.css
└── another.css
```
And a config like this:
```js
"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

```

example

Base Example

Hello world

console.log('hello world');

```

## 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.