psi-4ward/s7client

View on GitHub
docma.config.json

Summary

Maintainability
Test Coverage
{
  "debug": 5,
  "jsdoc": {
    "encoding": "utf8",
    "recurse": false,
    "pedantic": false,
    "access": null,
    "package": null,
    "module": true,
    "undocumented": false,
    "undescribed": false,
    "ignored": false,
    "hierarchy": true,
    "sort": "alphabetic",
    "relativePath": null,
    "filter": null,
    "allowUnknownTags": true,
    "plugins": []
  },
  "markdown": {
    "gfm": true,
    "tables": true,
    "breaks": false,
    "pedantic": false,
    "sanitize": false,
    "smartLists": true,
    "smartypants": false,
    "tasks": true,
    "emoji": true
  },
  "app": {
    "title": "S7Client",
    "meta": null,
    "base": "/s7client",
    "entrance": "content:readme",
    "routing": "query",
    "server": "github"
  },
  "template": {
    "path": "default",
    "options": {
      "title": "S7Client",
      "sidebar": true,
      "collapsed": false,
      "outline": "flat",
      "badges": true,
      "symbolMeta": false,
      "search": true,
      "navbar": true,
      "navItems": [
        {
          "iconClass": "ico-md ico-info",
          "label": "Guide",
          "items": [
            {
              "label": "Readme",
              "href": "./"
            },
            {
              "label": "Examples",
              "href": "https://github.com/psi-4ward/s7client/tree/master/examples",
              "target": "_blank"
            }
          ]
        },
        {
          "iconClass": "ico-book",
          "label": "API Reference",
          "href": "./?api=S7Client"
        },
        {
          "iconClass": "ico-md ico-github",
          "label": "GitHub",
          "href": "https://github.com/psi-4ward/s7client",
          "target": "_blank"
        },
        {
          "iconClass": "ico-md ico-download",
          "label": "Download",
          "items": [
            {
              "label": "<code>npm i s7client --save</code>",
              "href": "https://www.npmjs.com/package/s7client",
              "target": "_blank"
            },
            {
              "label": "<code>yarn add s7client</code>",
              "href": "https://yarn.pm/s7client",
              "target": "_blank"
            },
            {
              "separator": true
            },
            {
              "label": "Download as Archive",
              "href": "https://github.com/psi-4ward/s7client/releases",
              "target": "_blank"
            }
          ]
        }
      ]
    }
  },
  "src": [
    // grouped JS API documnetation
    {
      "S7Client": "./src/index.js",
      "Datatypes": "./src/datatypes.js"
    },
    {
      "readme": "./README.md"
    }
  ],
  "dest": "./docs"
}