chore: add docs deploy (#6)

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: deploy docs
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install dependencies
+        uses: ./.github/actions/install-dependencies
+
+      - name: Run the tests
+        run: bun run docs:deploy
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: ./docs

package.json

@@ -20,7 +20,9 @@
     "clean": "rimraf ./packages/core/_esm ./packages/core/_cjs ./packages/core/_types",
     "test": "vitest dev -c ./tests/vitest.config.ts",
     "test:ci": "CI=true vitest -c ./tests/vitest.config.ts --coverage",
-    "size": "size-limit"
+    "size": "size-limit",
+    "docs": "typedoc",
+    "docs:deploy": "bun run docs && gh-pages -d docs"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.5.3",
@@ -34,6 +36,7 @@
     "simple-git-hooks": "^2.9.0",
     "size-limit": "^9.0.0",
     "tsc-alias": "^1.8.8",
+    "typedoc": "^0.25.9",
     "vitest": "^1.3.1"
   },
   "peerDependencies": {