add doc page

.github/workflows/docs.yaml

@@ -0,0 +1,52 @@
+# ci.yml file for GitHub Actions
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build_and_lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+
+      - name: Retrieve the cached "node_modules" directory (if present)
+        uses: actions/cache@v2
+        id: node-cache
+        with:
+          path: node_modules
+          key: node-modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
+
+      - name: Install dependencies (if the cached directory was not found)
+        if: steps.node-cache.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - name: Create the docs directory locally in CI
+        run: npm run docs
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: docs
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/
+  deploy:
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build_and_lint
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        # https://github.com/actions/deploy-pages
+        uses: actions/deploy-pages@v4

.gitignore

@@ -3,4 +3,5 @@ node_modules
 coverage
 logs
 dist
-.env
+.env
+docs

package.json

@@ -19,7 +19,8 @@
     "dev": "ts-node-dev src/index.ts",
     "ts-node": "node --experimental-specifier-resolution=node --max-old-space-size=3072 --no-node-snapshot --loader ts-node/esm",
     "lint:fix": "eslint --fix \"src/**/*.{ts,tsx}\"",
-    "lint": "eslint \"src/**/*.{ts,tsx}\""
+    "lint": "eslint \"src/**/*.{ts,tsx}\"",
+    "docs": "typedoc"
   },
   "author": "",
   "license": "ISC",
@@ -43,6 +44,7 @@
     "p-queue": "^8.0.1",
     "regtest-client": "^0.2.1",
     "tiny-secp256k1": "^2.2.3",
+    "typedoc": "^0.26.5",
     "web3": "^4.10.0"
   },
   "type": "module",