wicked/config/jsdocrc.json

Generates github wiki compatible API documentation from your project's jsdocs and adds them to your wiki.

{
  "tags": {
    "allowUnknownTags": true
  },
  "source": {
    "includePattern": ".+\\.js(doc)?$",
    "excludePattern": ".*(node_modules|[.]git)"
  },
  "plugins": [ "plugins/markdown" ],
  "markdown": {
    "parser": "gfm",
    "hardwrap": true
  },
  "templates": {

    "cleverLinks"     :  true,
    "monospaceLinks"  :  false,
    "linenums"        :  true,
    "collapseSymbols" :  false,

    "default": {
      "outputSourceFiles": false
    }
  },
  "opts": {
    "recurse": true,
    "private": true
  }
}