KurtPattyn/karl

View on GitHub
jsdoc.conf

Summary

Maintainability
Test Coverage
{
  "tags": {
    "allowUnknownTags": false,
    "dictionaries": ["jsdoc", "closure"]
  },
  "source": {
    "include": [".", "package.json", "README.md"],
    "includePattern": ".js$",
    "excludePattern": "(node_modules/|docs|test|benchmarks)"
  },
  "plugins": [
    "plugins/markdown"
  ],
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": true,
    
    "default": {
      "outputSourceFiles": false,
      "outputSourcePath": false
    }
  },
  "opts": {
    "template": "node_modules/minami",  // same as -t templates/default
    "encoding": "utf8",                 // same as -e utf8
    "destination": "./docs/",           // same as -d ./out/
    "access": "public",
    "recurse": true,                    // same as -r
    "tutorials": ""                     // same as -u path/to/tutorials
  }
}