https://github.com/davidfig/jsdoc-template
jsdoc-template for my projects based on @pixi/jsdoc-template
https://github.com/davidfig/jsdoc-template
Last synced: 2 months ago
JSON representation
jsdoc-template for my projects based on @pixi/jsdoc-template
- Host: GitHub
- URL: https://github.com/davidfig/jsdoc-template
- Owner: davidfig
- License: mit
- Created: 2018-01-08T15:19:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-16T01:36:49.000Z (over 7 years ago)
- Last Synced: 2024-04-20T11:46:55.534Z (about 1 year ago)
- Language: JavaScript
- Size: 256 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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.