jsdoc.json

{
  "tags": {
    "allowUnknownTags": true
  },
  "source": {
    "include": [
      "./packages/adminjs/src",
      "./packages/adminjs-bundler/src",
      "./packages/adminjs-design-system/src",
      "./packages/adminjs-expressjs/src",
      "./packages/adminjs-fastify/src",
      "./packages/adminjs-firebase-functions/src",
      "./packages/adminjs-hapijs/src",
      "./packages/adminjs-import-export/src",
      "./packages/adminjs-koa/src",
      "./packages/adminjs-logger/src",
      "./packages/adminjs-mikroorm/src",
      "./packages/adminjs-mongoose/src",
      "./packages/adminjs-nestjs/src",
      "./packages/adminjs-passwords/src",
      "./packages/adminjs-prisma/src",
      "./packages/adminjs-sequelizejs",
      "./packages/adminjs-typeorm/src",
      "./packages/adminjs-upload/src"
    ],
    "includePattern": "\\.(jsx|js|ts|tsx)$",
    "excludePattern": "node_modules/|(bundle.*\\.js)|cli.ts|adminjs/docs|(\\.spec.ts)$"
  },
  "plugins": [
    "better-docs/category",
    "better-docs/component",
    "better-docs/load",
    "better-docs/navigation",
    "better-docs/typedef-import",
    "better-docs/typescript",
    "jsdoc-mermaid",
    "node_modules/jsdoc-escape-at",
    "node_modules/jsdoc-typeof-plugin",
    "plugins/markdown"
  ],
  "markdown": {
    "tags": ["load"]
  },
  "opts": {
    "encoding": "utf8",
    "destination": "docs",
    "readme": "./docs-src/home.md",
    "recurse": true,
    "private": true,
    "verbose": true,
    "tutorials": "./docs-src/tutorials",
    "sections": "./docs-src/sections",
    "template": "better-docs"
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false,
    "search": true,
    "default": {
      "includeDate": false,
      "staticFiles": {
        "include": [
          "./docs-src/statics",
          "./packages/adminjs/src/frontend/assets/styles",
          "./packages/adminjs/src/frontend/assets/fonts"
        ]
      }
    },
    "better-docs": {
      "logo": "images/logo-reg.svg",
      "title": "AdminJS - Auto-generated admin panel for node.js with react",
      "component": {
        "wrapper": "./packages/adminjs/docs/component.tsx"
      },
      "trackingCode": "<!-- Google Tag Manager -->\n<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':\nnew Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],\nj=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=\n'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);\n})(window,document,'script','dataLayer','GTM-K6R3HZ4');</script>\n<!-- End Google Tag Manager -->",
      "bodyTrackingCode": "<!-- Google Tag Manager (noscript) -->\n<noscript><iframe src=\"https://www.googletagmanager.com/ns.html?id=GTM-K6R3HZ4\"\nheight=\"0\" width=\"0\" style=\"display:none;visibility:hidden\"></iframe></noscript>\n<!-- End Google Tag Manager (noscript) -->",
      "head": "<link rel=\"stylesheet\" type=\"text/css\" href=\"fonts.css\"/>",
      "ogTags": {
        "title": "An Auto-generated Admin Panel for your Node.js Application",
        "description": "You, as a developer, provide database models, and AdminJS generates ReactJS UI which allows you (or other trusted users) to manage content.",
        "image": "https://adminbro.com/splash/adminjs.png"
      },
      "navButtons": [
        {
          "label": "Demo",
          "href": "https://admin-bro-example-app-staging.herokuapp.com/admin",
          "target": "_blank",
          "className": "is-primary is-outlined"
        },
        {
          "label": "Get Started",
          "href": "/tutorial-installation-instructions.html",
          "className": "is-primary is-outlined"
        },
        {
          "label": "<i class=\"fab fa-slack-hash fa-lg\"></i> Join the community",
          "href": "https://join.slack.com/t/adminbro/shared_invite/zt-djsqxxpz-_YCS8UMtQ9Ade6DPuLR7Zw",
          "className": "is-primary"
        }
      ],
      "navLinks": [
        {
          "label": "<i class=\"fab fa-github fa-3x\"></i>",
          "href": "https://github.com/SoftwareBrothers/adminjs",
          "className": "no-hover"
        }
      ],
      "softwareBrothers": "paranoid"
    }
  }
}