Add typedoc

Author: jdesrosiers

.github/workflows/docs.yml

@@ -0,0 +1,35 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - v2
+  release:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - run: npm install
+      - run: npm run docs
+      - uses: actions/configure-pages@v5
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs'
+  deploy:
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/deploy-pages@v4
+        id: deployment

.github/workflows/nodejs.yml

@@ -16,3 +16,4 @@ jobs:
       - run: npm test
       - run: npm run lint
       - run: npm run type-check
+      - run: npm run docs

.gitignore

@@ -1,5 +1,7 @@
 node_modules/
 package-lock.json
 
+docs/
+
 scratch/
 TODO*

package.json

@@ -31,6 +31,7 @@
     "test": "vitest --watch=false",
     "coverage": "vitest run --coverage",
     "type-check": "tsc --noEmit",
+    "docs": "typedoc",
     "prepack": "tsc --project tsconfig.build.json",
     "postpack": "node ./bin/postpack.js"
   },
@@ -44,6 +45,7 @@
     "@typescript-eslint/parser": "*",
     "eslint-import-resolver-typescript": "*",
     "eslint-plugin-import": "*",
+    "typedoc": "^0.27.6",
     "typescript-eslint": "*",
     "undici": "^7.3.0",
     "vitest": "*"