# pixi-jsdoc-template

**Repository Path**: mirrors_pixijs/pixi-jsdoc-template

## Basic Information

- **Project Name**: pixi-jsdoc-template
- **Description**: PixiJS Flavored JSDoc Template
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-12-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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": "",
      "favicon": "path/to/favicon.png",
      "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"
      }
  },
  "pixi": {
      "styles": ["path/to/custom/styles.css"],
      "scripts": ["path/to/custom/script.js"]
   }
}
```

## License

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