restaf/jsdoc.json at main · sassoftware/restaf · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "plugins": ["plugins/markdown", "node_modules/better-docs/category"],
  "recurseDepth": 10,
  "source": {
    "include": [
      "main-types.js",
      ".other packages..."
 ],
    "exclude": ["./packages/restaflib/src/print"],
    "includePattern": ".js",
    "excludePattern": "(node_modules)"
  },
  "tags": {
    "allowUnknownTags": ["category"],
    "dictionaries": ["jsdoc"]
  },

  "templates": {
    "cleverLinks": true,
    "search": true,
    "monospaceLinks": true,
    "useLongnameInNav": true,
    "showInheritedInNav": true,
    "default": {
      "outputSourceFiles": false
      }

  },
  "opts": {
    "template": "node_modules/better-docs",
    "destination": "./jsdocs",
    "recurse": true,
    "private": true,
    "readme": "./README.md",
    "tutorials": "./tutorials"
  }

}