jsdoc.json

{
  "source": {
    "includePattern": "\\.(ts)$",
    "excludePattern": ".+\\.(test|spec).(t|j)s(doc|x)?$",
    "exclude": [
      "__snapshots__",
      "test",
      "src/test",
      "__tests__",
      "build",
      "coverage",
      "logo",
      "node_modules",
      "app/api-destined-function/node_modules",
      "app/api-destined-function/layers",
      "dist",
      "private",
      "public"
    ]
  },
  "plugins": [
    "plugins/markdown",
    "plugins/summarize",
    "jsdoc-mermaid",
    "jsdoc-plugin-typescript",
    "node_modules/better-docs/typescript"
  ],
  "typescript": {
    "moduleRoot": "src"
  },
  "docdash": {
    "static": true,
    "sort": true,
    "search": true,
    "collapse": true,
    "typedefs": true,
    "removeQuotes": "none",
    "commonNav": true,
    "wrap": false,
    "scripts": [],
    "menu": {
      "Github repo": {
        "href": "https://github.com/gradientedge/cdk-utils",
        "target": "_blank",
        "class": "menu-item",
        "id": "repository"
      }
    },
    "sectionOrder": [
      "Mixins",
      "Classes",
      "Interfaces",
      "Modules",
      "Externals",
      "Events",
      "Namespaces",
      "Globals",
      "Tutorials"
    ]
  },
  "opts": {
    "destination": "api-docs/",
    "encoding": "utf8",
    "readme": "README.md",
    "recurse": true,
    "tutorials": "docs/",
    "template": "node_modules/docdash"
  },
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc", "closure"]
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false,
    "search": true,
    "default": {
      "useLongnameInNav": true,
      "layoutFile": "./theme/layout.tmpl",
      "outputSourceFiles": true,
      "staticFiles": {
        "include": [
          "./img/logo.png",
          "./img/ApiToEventBridgeTarget.jpg",
          "./img/ApiToEventBridgeTargetWithSns.jpg",
          "./img/GraphQLApiLambda.jpg",
          "./theme/main.css"
        ]
      }
    }
  }
}