jsdoc.json

{
    "tags": {
        "allowUnknownTags": ["alpha", "beta"]
    },
    "source": {
        "include": [
          "./src",
          "./README.md"
        ],
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "plugins/markdown",
        "./theme/plugins/custom-tags.js"
    ],
    "opts": {
        "template": "theme/",
        "encoding": "utf8",
        "destination": ".",
        "recurse": true,
        "verbose": true
    },
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    },
    "docdash": {
      "static": true,         // Display the static members inside the navbar
      "sort": true,           // Sort the methods in the navbar
      "sectionOrder": [        // Order the main section in the navbar (default order shown here)
           "Classes",
           "Modules",
           "Externals",
           "Events",
           "Namespaces",
           "Mixins",
           "Tutorials",
           "Interfaces"
      ],
      "disqus": "",                   // Shortname for your disqus (subdomain during site creation)
      "openGraph": {                  // Open Graph options (mostly for Facebook and other sites to easily extract meta information)
          "title": "",                // Title of the website
          "type": "website",          // Type of the website
          "image": "",                // Main image/logo
          "site_name": "",            // Site name
          "url": ""                   // Main canonical URL for the main page of the site
      },
      "meta": {                       // Meta information options (mostly for search engines that have not indexed your site yet)
          "title": "",                // Also will be used as postfix to actualy page title, prefixed with object/document name
          "description": "",          // Description of overal contents of your website
          "keyword": ""               // Keywords for search engines
      },
      "search": true        // Display seach box above navigation which allows to search/filter navigation items
  }
}