Issue-430 - Publish typedocs

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: Publish Docs
+
+on:
+  release:
+    types: [published]
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: ./.github/actions/configure-nodejs
+
+      - name: Build Docs
+        run: npm run build:docs
+
+      # On Settings -> Pages, select:
+      # - Source -> Deploy from Branch
+      # - Branch: gh-pages, Folder: / (root)
+      # - Enforce HTTPS
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

package.json

@@ -25,6 +25,7 @@
   },
   "scripts": {
     "build": "tsc",
+    "build:docs": "typedoc ./index.ts",
     "prepare": "husky",
     "prepublishOnly": "rm -rf dist && npm run test",
     "test": "eslint lib/* ./cli.ts && tsc && jest ./tests/sitemap*",
@@ -75,6 +76,7 @@
     "stats-lite": "^2.2.0",
     "stream-json": "^1.7.1",
     "through2-map": "^4.0.0",
+    "typedoc": "0.25.13",
     "typescript": "^5.4.5"
   },
   "engines": {