actionhero/jsdoc-conf.json

actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks

{
  "source": {
    "include": [
      "actionhero.js",
      "initializers",
      "config"
    ],
    "exclude": [
      "test",
      "bin/templates"
    ],
    "includePattern": ".+\\.js(doc|x)?$",
    "excludePattern": "(^|\\/|\\\\)_"
  },
  "opts": {
    "destination": "./docs",
    "template": "node_modules/docdash",
    "tutorials": "./tutorials",
    "readme": "./README.md",
    "recurse": false,
    "verbose": true
  },
  "templates": {
    "default": {
      "includeDate": false,
      "staticFiles": {
        "include": [
          "./tutorials/images",
          "./public/docs"
        ]
      }
    }
  },
  "plugins": [
    "plugins/markdown"
  ],
  "docdash": {
    "meta": {
      "title": "ActionHero Documentation",
      "keyword": "ActionHero Node Framework Docs Documentation",
      "description": "Documentation for the ActionHero.js Node.js framework"
    },
    "menu":{
      "Main Website":{
        "href":"https://actionherojs.com",
        "target":"_blank",
        "class":"menu-item",
        "id":"website_link"
      },
      "Slack":{
        "href":"https://slack.actionherojs.com",
        "target":"_blank",
        "class":"menu-item",
        "id":"forum_link"
      }
    },
    "search": false,
    "collapse": true,
    "typedefs": false,
    "scripts": [
      "scripts/logo.js",
      "scripts/style.js",
      "scripts/VERSIONS.js",
      "scripts/version-navigation.js",
      "scripts/google-analytics.js"
    ],
    "sectionOrder": [
      "Tutorials",
      "Classes",
      "Modules",
      "Externals",
      "Events",
      "Namespaces",
      "Mixins",
      "Interfaces"
    ]
  }
}