ci: add typedoc action build

.github/FUNDING.yml

@@ -1 +1,2 @@
-github: sinkaroid
+github: sinkaroid
+patreon: scathach_bot

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build-and-deploy:
+    concurrency: ci-${{ github.ref }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: |
+          npm i --save-dev
+          npm run docs
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4.2.5
+        with:
+          branch: gh-pages
+          folder: docs

README.md

@@ -0,0 +1,10 @@
+# Features
+- Serverless
+- Reverse image proxy
+- Ratelimiting
+- Redis cluster support
+
+# Information
+- [Cloudflare Workers](https://workers.cloudflare.com/)
+- [Lambda Functions](https://www.netlify.com/products/functions/)
+- [Documentation](https://scathachgrip.github.io/gaebolg/)

package.json

@@ -12,8 +12,9 @@
     "build": "netlify-lambda build src",
     "dev": "netlify dev",
     "ts-check": "tsc --noEmit --lib ES2015 ./src/*.ts",
-    "lint": "npx eslint . --ext .ts",
-    "lint:fix": "npx eslint . --fix"
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --fix",
+    "docs": "typedoc --entryPointStrategy expand src/"
   },
   "dependencies": {
     "async-ratelimiter": "^1.3.7",
@@ -34,6 +35,7 @@
     "@typescript-eslint/parser": "^5.57.0",
     "eslint": "^8.36.0",
     "netlify-lambda": "^2.0.1",
+    "typedoc": "^0.24.1",
     "typescript": "^5.0.2"
   }
 }