Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-14 21:46:50 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
overte/tools/jsdoc/hifi-jsdoc-template
History
kasenvr 5c2dab6ba5
Merge pull request #314 from kasenvr/kasen/core 
Update master with kasen/core's latest changes
2020-04-25 14:46:01 -04:00
..
static API docs rebranded to Vircadia. 2020-04-07 02:11:29 -04:00
tmpl Merge pull request #314 from kasenvr/kasen/core 2020-04-25 14:46:01 -04:00
LICENSE.md Add @signal tag to jsdoc; use custom jsdoc templates 2019-02-23 21:10:40 -08:00
package.json Add @signal tag to jsdoc; use custom jsdoc templates 2019-02-23 21:10:40 -08:00
publish.js API docs rebranded to Vircadia. 2020-04-07 02:11:29 -04:00
README.md Add @signal tag to jsdoc; use custom jsdoc templates 2019-02-23 21:10:40 -08:00

README.md

hifi-jsdoc-template

The hifi-jsdoc-template is based on the DocDash template.

Usage

Clone repository to your designated jsdoc/node_modules template directory.

In your config.json file, add a template option.

"opts": {
  "template": "node_modules/hifi-jsdoc-template"
}

Sample config.json

{
    "opts": {
        "template": "node_modules/hifi-jsdoc-template"
    },
    "docdash": {
        "meta": {                       
            "title": "",                
            "description": "",          
            "keyword": ""               
        },
        "search": [true],  
        "collapse": [true],       
        "typedefs": [false]    
    },    
    "templates": {
        "default": {
            "outputSourceFiles": false
        }
    },
    "plugins": [
        "plugins/hifi",
        "plugins/hifiJSONExport"
    ]
}