# yy-jsdoc-template

> YOPEY YOPEY LLC template for JSDoc 3 ased on @pixijs/jsdoc-template

Latest version **1.3.0** (published 2018-01-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install yy-jsdoc-template
pnpm add yy-jsdoc-template
yarn add yy-jsdoc-template
bun add yy-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.3.0 |
| Published | 2018-01-16 |
| First published | 2018-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | davidfig |
| Keywords | jsdoc, jsdoc3, template |

## Links

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

## Dependencies (2)

- [taffydb](https://npm.io/package/taffydb.md) ^2.7.2
- [underscore](https://npm.io/package/underscore.md) ^1.7.0

## Recent versions

- 1.3.0 (latest) — 2018-01-16
- 1.2.0 — 2018-01-11
- 1.1.0 — 2018-01-10
- 1.0.0 — 2018-01-09

## README

# PixiJS template for JSDoc 3

- [PixiJS](http://pixijs.com/)
- [JSDoc3](https://github.com/jsdoc3/jsdoc)
- [JSDoc3 API Documentations](http://usejsdoc.org)

## Installation

Install the template using NPM:

```bash
npm install @pixi/jsdoc-template --save-dev
```

## Usage

If you already have JSDoc system, you can use this project as JSDoc template. More information about JSDoc command-line arguments can be found [here](http://usejsdoc.org/about-commandline.html).
 
```bash
jsdoc -c conf.json -R README.md
```

### conf.json

You can set options for customizing your documentations. Notice the `"template"` field for setting the path to **pixi-jsdoc-template**.

```json
"templates": {
    "applicationName": "Demo",
    "disqus": "",
    "googleAnalytics": "",
    "openGraph": {
        "title": "",
        "type": "website",
        "image": "",
        "site_name": "",
        "url": ""
    },
    "meta": {
        "title": "",
        "description": "",
        "keyword": ""
    },
    "linenums": true,
    "source": {
        "include": [
            "./src/"
        ],
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "opts": {
        "encoding": "utf8",
        "recurse": true,
        "private": false,
        "lenient": true,
        "destination": "./docs",
        "template": "./node_modules/@pixi/jsdoc-template"
    }
}
```

## License

This project under the MIT License. and this project refered by default template for JSDoc 3.

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