Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-08-05 05:10:01 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-JulianGro/tools/jsdoc/hifi-jsdoc-template
History
Alezia Kurdis f97b1dfe87
Ressources rebranding for Overte 
Ressources rebranding for Overte
(mostly images, icon, model updated with Overte brand)
some file has been edited to replace some files (they had vircadia in the name)
Most of this has not been tested. (cause I don't build)
2022-02-06 12:51:05 -05:00
..
static Ressources rebranding for Overte 2022-02-06 12:51:05 -05:00
tmpl Ressources rebranding for Overte 2022-02-06 12:51:05 -05:00
LICENSE.md
package.json
publish.js Statically generate canonical link tag instead. 2021-05-31 06:39:52 -04:00
README.md

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"
    ]
}