Merge pull request #6 from DouglasNeuroInformatics/docs

docs: use same theme as libnest for docs

Author: joshunrau

.github/workflows/docs.yaml

@@ -30,7 +30,7 @@ jobs:
       - name: Install Dependencies
         run: pnpm install --frozen-lockfile
       - name: Build Site
-        run: pnpm build:docs
+        run: pnpm docs:build
       - name: Upload Artifact
         uses: actions/upload-pages-artifact@v3
         with:

package.json

@@ -21,7 +21,8 @@
   ],
   "scripts": {
     "build": "rm -rf dist && tsc -b tsconfig.build.json",
-    "build:docs": "typedoc",
+    "docs:build": "typedoc",
+    "docs:dev": "concurrently \"typedoc --watch\" \"http-server docs -c-1\"",
     "format": "prettier --write src",
     "lint": "tsc --noEmit && eslint --fix src",
     "prepare": "husky",
@@ -39,10 +40,14 @@
     "@douglasneuroinformatics/tsconfig": "^1.0.2",
     "@types/node": "22.x",
     "@vitest/coverage-v8": "^3.0.5",
+    "concurrently": "^9.1.2",
     "eslint": "^9.20.1",
+    "http-server": "^14.1.1",
     "husky": "^9.1.7",
     "prettier": "^3.5.0",
-    "typedoc": "^0.27.7",
+    "typedoc": "^0.27.8",
+    "typedoc-material-theme": "^1.3.0",
+    "typedoc-plugin-zod": "^1.3.1",
     "typescript": "5.6.x",
     "vitest": "^3.0.5"
   },