chore: generate and deploy jsdoc (#15)

* chore: generate and deploy jsdoc

* chore: workflow dispatch to update docs

Author: birme

.github/workflows/dispatch.yml

@@ -0,0 +1,35 @@
+name: Manually update and publish documentation
+
+on: workflow_dispatch
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org/
+      - run: |
+          npm install
+          npm run build:docs
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - name: Upload static files as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/
+
+  deploy-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy-docs.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build-docs
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish.yml

@@ -18,6 +18,23 @@ jobs:
           npm install
           npm test
           npm run build
+          npm run build:docs
           npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - name: Upload static files as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/
+
+    deploy-docs:
+      environment:
+        name: github-pages
+        url: ${{ steps.deploy-docs.outputs.page_url }}
+      runs-on: ubuntu-latest
+      needs: build
+      steps:
+        - name: Deploy to GitHub Pages
+          id: deployment
+          uses: actions/deploy-pages@v4

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 .DS_Store
 lib/
+docs/

.prettierignore

@@ -1 +1,2 @@
 lib/
+docs/

jsdoc.json

@@ -0,0 +1,14 @@
+{
+  "tags": {
+    "allowUnknownTags": ["optional"]
+  },
+  "plugins": ["node_modules/better-docs/typescript"],
+  "source": {
+    "include": ["readme.md", "src"],
+    "includePattern": "\\.(jsx|js|ts|tsx)$",
+    "excludePattern": "(node_modules/|docs)"
+  },
+  "opts": {
+    "destination": "./docs/"
+  }
+}