jsdoc.json

{
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc"]
  },
  "source": {
    "include": ["./dist/", "./README.md"],
    "includePattern": ".js$",
    "excludePattern": "(./node_modules/|./test/|.test.js)"
  },
  "plugins": ["plugins/markdown"],
  "opts": {
    "destination": "./docs/",
    "encoding": "utf8",
    "recurse": true,
    "verbose": true,
    "template": "./node_modules/docdash"
  },
  "markdown": {
    "parser": "gfm",
    "hardwrap": true,
    "idInHeadings": true
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false,
    "default": {
      "outputSourceFiles": true,
      "includeDate": false,
      "useLongnameInNav": true
    }
  },
  "docdash": {
    "static": true,
    "sort": true,
    "disqus": "",
    "openGraph": {
      "title": "Node.js: fs-hospitality",
      "type": "website",
      "image": "https://docs.tuckn.net/node-fs-hospitality/img/openGraph-image.png",
      "site_name": "@tuckn/fs-hospitality",
      "url": "https://docs.tuckn.net/node-fs-hospitality"
    },
    "meta": {
      "title": "node-fs-hospitality",
      "description": "Extra methods for fs object. e.g. readAsText read a file with detecting automatically a character encoding. ",
      "keyword": "fs, file, file system, read, write, text, character"
    },
    "search": true,
    "collapse": false,
    "wrap": false,
    "typedefs": true,
    "removeQuotes": "none",
    "menu": {
      "Github repo": {
        "href": "https://github.com/tuckn/node-fs-hospitality",
        "target": "_blank",
        "class": "menu-item",
        "id": "repository"
      }
    }
  }
}