jsdoc.json

{
  "tags": {
    "allowUnknownTags": true
  },
  "source": {
    "include": "../application/source/",
    "includePattern": ".+\\.(js(doc|x)?|mjs)$",
    "excludePattern": "(node_modules|test)"
  },
  "plugins": [
    "plugins/markdown",
    "jsdoc-plantuml",
    "plugins/summarize",
    "jsdoc-external-example"
  ],
  "sourceType": "module",
  "opts": {
    "template": "node_modules/clean-jsdoc-theme",
    "encoding": "utf8",
    "destination": "../deployment/build/docs/",
    "recurse": true,
    "verbose": false,
    "theme_opts": {
      "default_theme": "dark",
      "title": "Monster ",
      "favicon": "https://monsterjs.org/favicon.ico",
      "menu" : [
        {
          "title": "Home",
          "link": "https://monsterjs.org/",
          "target": "_self",
          "class": "",
          "id": "home"
        },
        {
          "title": "Imprint",
          "link": "https://about.schukai.com/de/impressum/",
          "target": "_blank",
          "class": "",
          "id": "imprint"          
        }
      ],
      "meta": [
        {
          "name": "author",
          "content": "schukai GmbH"
        },
        {
          "name": "description",
          "content": "javascript library for optimal use on fast and flexible pages."
        }
      ],
      "search": true,
      "add_style_path": [
      ],
      "add_script_path": [
        {
          "src": "https://code.jquery.com/jquery-3.5.1.js",
          "integrity": "sha256-QWo7LDvxbWT2tbbQ97B53yJnYU3WhH/C8ycbRAkjPDc=",
          "crossorigin": "anonymous"
        }
      ],
      "codepen": {
        "enable_for": [
          "examples"
        ],
        "options": {
          "title": "awaken the monster in you; javascript library by schukai GmbH",
          "description": "the example ...",
          "editors": "0012"
        }
      },
      "sections": [
        "Tutorials",
        "Modules",
        "Classes",
        "Externals",
        "Events",
        "Namespaces",
        "Mixins",
        "Interfaces",
        "Global"
      ]
    }
  },
  "templates": {
    "cleverLinks": true,
    "monospaceLinks": false,
    "default": {
      "outputSourceFiles": false
    }
  },
  "markdown": {
    "parser": "gfm",
    "hardwrap": false,
    "idInHeadings": true
  },
  "plantuml": {
    "puml": {
      "create": true,
      "destination": "../deployment/build/docs/puml"
    },
    "images": {
      "create": true,
      "destination": "../deployment/build/docs/images",
      "defaultFormat": "svg"
    }
  }
}