Implement Auto-Publishing of Docs to GitHub Pages (Issue #333)

.github/workflows/publish-docs.ym

@@ -0,0 +1,32 @@
+name: Publish Documentation
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1
+
+    - name: Set up Node.js
+      uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
+      with:
+        node-version: '18'
+
+    - name: Install Dependencies
+      run: npm install
+
+    - name: Generate Documentation
+      run: npx typedoc
+
+    - name: Deploy to GitHub Pages
+      uses: JamesIves/[email protected]
+      with:
+        branch: gh-pages # The branch the action should deploy to.
+        folder: docs # The folder the action should deploy.

package.json

@@ -25,6 +25,7 @@
   "devDependencies": {
     "@npmcli/package-json": "5.0.0",
     "@typescript-eslint/eslint-plugin": "6.4.0",
-    "eslint-plugin-mocha": "10.1.0"
+    "eslint-plugin-mocha": "10.1.0",
+    "typedoc": "^0.25.4"
   }
 }