Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

Template for High Fidelity's JSDoc system

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages