Merge pull request #12 from cse210-works-on-my-machine/devops/jsdocs

Devops/jsdocs

.github/workflows/jsdoc.yml

@@ -0,0 +1,40 @@
+name: Generate and Deploy JSDoc
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main  
+
+jobs:
+  documentation:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Install Dependencies
+      run: npm install
+
+    - name: Generate JSDoc Documentation
+      run: npm run generate-docs  
+
+    - name: Deploy Documentation to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      permissions:
+        contents: write
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs  

jsdoc.json

@@ -0,0 +1,27 @@
+{
+    "source": {
+      "include": ["src"],
+      "exclude": ["node_modules"],
+      "includePattern": ".+\\.js(doc|x)?$",
+      "excludePattern": "(^|\\/|\\\\)_"
+    },
+    "plugins": [
+      "plugins/markdown"
+    ],
+    "templates": {
+      "cleverLinks": false,
+      "monospaceLinks": false,
+      "default": {
+        "outputSourceFiles": true
+      },
+      "systemName": "CSE 210 Project Documentation",
+      "footer": "Copyright 2023 Works On My Machine",
+      "includeDate": true
+    },
+    "opts": {
+      "encoding": "utf8",
+      "destination": "docs/",
+      "recurse": true,
+      "verbose": true
+    }
+  }