Skip to content
PixiJS Flavored JSDoc Template
JavaScript CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
plugins Fix to allow for named exports in PIXI Aug 29, 2019
src Creates better visual representation of deprecated (#5) Nov 23, 2017
static Upgrade bootstrap, added small screen layout Sep 19, 2017
tmpl Adds Implements section (#20) Dec 11, 2019
.gitignore Better style Sep 18, 2017
LICENSE Initial commit Dec 30, 2013
README.md Move to npm pixi namespace Sep 18, 2017
package-lock.json 2.4.3 Aug 29, 2019
package.json 2.4.3 Aug 29, 2019
publish.js Reverts f6cbeca commit Jul 4, 2018

README.md

PixiJS template for JSDoc 3

Installation

Install the template using NPM:

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.

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.

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

You can’t perform that action at this time.