Add docs

Author: hildjj

.github/workflows/publish.yml

@@ -11,7 +11,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       id-token: write
     steps:
       - uses: actions/checkout@v4
@@ -25,6 +25,12 @@ jobs:
       - run: npm run build
       - run: npm run test
       - run: npm pkg delete devDependencies scripts packageManager
+      - name: Deploy Docs
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs
+          publish_branch: gh-pages
       - run: npm publish --access public --provenance
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
 coverage/
 node_modules/
 .vscode/
+docs/

.npmignore

@@ -4,6 +4,8 @@
 .ncurc
 .vscode/
 coverage/
+docs/
 eslint.config.js
 test/
 tsconfig.json
+typedoc.config.js

package.json

@@ -36,9 +36,10 @@
     "@types/node": "22.9.1",
     "c8": "10.1.2",
     "eslint": "9.15.0",
+    "typedoc": "0.26.11",
     "typescript": "5.6.3"
   },
-  "packageManager": "pnpm@9.13.2",
+  "packageManager": "pnpm@9.14.2",
   "pnpm": {
     "overrides": {
       "@eslint/plugin-kit": "^0.2.3",