# daybrush-jsdoc-template

> A clean, responsive documentation template theme for JSDoc 3 inspired by lodash and minami

Latest version **1.10.0** (published 2023-01-28) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install daybrush-jsdoc-template
pnpm add daybrush-jsdoc-template
yarn add daybrush-jsdoc-template
bun add daybrush-jsdoc-template
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.10.0 |
| Published | 2023-01-28 |
| First published | 2018-08-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 202.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Daybrush |
| Maintainers | younkue |
| Keywords | jsdoc, template, tsdoc, javascript, typescript |

## Links

- npm: https://www.npmjs.com/package/daybrush-jsdoc-template
- Repository: https://github.com/daybrush/daybrush-jsdoc-template
- Homepage: https://github.com/daybrush/daybrush-jsdoc-template#readme
- Issues: https://github.com/daybrush/daybrush-jsdoc-template/issues
- npm.io page: https://npm.io/package/daybrush-jsdoc-template

## Dependencies (2)

- [@daybrush/jsdoc](https://npm.io/package/@daybrush/jsdoc.md) ^0.4.0
- [@daybrush/utils](https://npm.io/package/@daybrush/utils.md) ^1.6.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.10.0 (latest) — 2023-01-28
- 1.9.0 — 2023-01-27
- 1.8.0 — 2022-11-28
- 1.7.0 — 2022-04-14
- 1.6.0 — 2019-05-30
- 1.5.3 — 2019-04-12
- 1.5.2 — 2019-02-09
- 1.5.1 — 2019-02-08
- 1.5.0 — 2019-01-16
- 1.5.0-rc — 2019-01-12
- 1.4.4 — 2018-12-30
- 1.4.3 — 2018-12-28
- 1.4.2 — 2018-12-27
- 1.4.1 — 2018-12-27
- 1.4.0 — 2018-12-27
- … 13 more at https://npm.io/package/daybrush-jsdoc-template/versions

## README

# daybrush-jsdoc-template
[![npm package](https://img.shields.io/npm/v/daybrush-jsdoc-template.svg)](https://www.npmjs.com/package/daybrush-jsdoc-template) [![license](https://img.shields.io/npm/l/daybrush-jsdoc-template.svg)](LICENSE.md)

**daybrush-jsdoc-template** is a template based on the [**docdash**](https://github.com/clenemt/docdash) template.

* [Demo](http://daybrush.github.io/scenejs/release/latest/doc/)

## Install

```bash
$ npm install daybrush-jsdoc-template
```

## Usage
Clone repository to your designated `jsdoc` template directory, then:

```bash
$ jsdoc entry-file.js -t path/to/daybrush-jsdoc-template
```

### scene.js
```bash
$  jsdoc ./outjs ./README.md -d doc -t ./node_modules/daybrush-jsdoc-template
```

## Usage (npm)
In your projects `package.json` file add a new script:

```json
"script": {
  "generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json"
}
```

In your `jsdoc.json` file, add a template option.

```json
"opts": {
  "template": "node_modules/daybrush-jsdoc-template"
}
```

---
_Source: https://npm.io/package/daybrush-jsdoc-template · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._