Added docs command

nylas · Aug 11, 2023 · 9247da0 · 9247da0
1 parent a72abc0
commit 9247da0
Show file tree

Hide file tree

Showing 3 changed files with 208 additions and 1 deletion.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -19,7 +19,8 @@
     "lint:prettier": "prettier --write '**/*.{ts,js}'",
     "lint:prettier:check": "prettier --check '**/*.{ts,js}'",
     "build": "tsc",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "build:docs": "typedoc --out docs"
   },
   "keywords": [
     "email",
@@ -50,6 +51,8 @@
     "jest": "^29.6.1",
     "prettier": "^1.19.1",
     "ts-jest": "^29.1.1",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.1",
     "typescript": "^4.9.5"
   },
   "repository": {

diff --git a/tsconfig.json b/tsconfig.json
@@ -8,5 +8,12 @@
     "resolveJsonModule": true,
     "strict": true
   },
+  "typedocOptions": {
+      "entryPoints": ["src/nylas.ts"],
+      "out": "docs",
+      "plugin": ["typedoc-plugin-missing-exports"],
+      "excludeExternals": true,
+      "excludePrivate": true,
+  },
   "exclude": ["tests", "lib"]
 }