Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-05 23:42:58 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-JulianGro/tools/jsdoc/hifi-jsdoc-template
History
Julian Groß 9adca218af
Merge pull request #157 from JulianGro/fix-jsdoc-examples 
Fix apidocs example files
2022-08-13 10:41:33 +02:00
..
static Merge pull request #157 from JulianGro/fix-jsdoc-examples 2022-08-13 10:41:33 +02:00
tmpl Update jsdoc 2022-02-19 17:59:44 +01: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 Updated some URLs, rebranded documentation and changed default metaverse server address 2022-02-09 23:57:24 +01: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"
    ]
}