Add Typedoc definitions and categories (#1127)

* Add Typedoc definitions and categories

* Add markdown option

.config/typedoc.json

@@ -0,0 +1,14 @@
+{
+  "categorizeByGroup": false,
+  "categoryOrder": ["Main Classes", "API Response Types", "API Models", "*"],
+  "entryPoints": ["../src/index.ts"],
+  "excludePrivate": true,
+  "excludeReferences": true,
+  "includeVersion": true,
+  "out": "../docs",
+  "validation": {
+    "notExported": true,
+    "invalidLink": true,
+    "notDocumented": true
+  }
+}

package.json

@@ -23,7 +23,8 @@
     "bundle": "browserify lib/index.js -o lib/bundle.js",
     "check-types": "tsc --noEmit --project tsconfig.json",
     "coverage-report": "nyc report --reporter=lcov",
-    "docs-build": "typedoc --out docs src/index.ts",
+    "docs-build": "typedoc",
+    "docs-build-md": "typedoc --plugin typedoc-plugin-markdown",
     "eslint:check": "eslint . --max-warnings 0 --ext .js,.ts",
     "eslint:fix": "npm run eslint:check -- --fix",
     "postinstall": "husky install || exit 0",
@@ -67,7 +68,8 @@
     "prettier-package-json": "^2.8.0",
     "ts-node": "10.9.1",
     "typechain": "^8.0.0",
-    "typedoc": "^0.24.0",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-markdown": "^3.15.4",
     "typescript": "^5.1.3"
   },
   "keywords": [