Autogenerate documentation

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: Generate docs
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  generate-docs:
+    name: Generate docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Sync the Github Wiki
+        uses: arciera/github-wiki-sync@main
+
+        with:
+          build_script: docs
+          docs_folder: docs
+          message: "chore: update documentation"
+          auth_token: ${{ secrets.GITHUB_TOKEN }}
+          repo: ${{ github.repository }}
+          name: ${{ github.actor }}

.gitignore

@@ -133,3 +133,6 @@ dist
 *.js
 *.d.ts
 .idea
+
+# documentation
+docs/

package.json

@@ -8,6 +8,7 @@
     "build": "tsc",
     "build:start": "npm run build && npm run start",
     "bundle": "ncc build ./index.ts -o build -m",
+    "docs": "typedoc",
     "start": "node dist/index.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -16,7 +17,10 @@
   "license": "GNU GPLv3",
   "devDependencies": {
     "@types/node": "^20.4.9",
-    "typescript": "^5.1.6",
-    "@vercel/ncc": "^0.36.1"
+    "@vercel/ncc": "^0.36.1",
+    "typedoc": "^0.24.8",
+    "typedoc-github-wiki-theme": "^1.1.0",
+    "typedoc-plugin-markdown": "^3.15.4",
+    "typescript": "^5.1.6"
   }
 }

typedoc.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "entryPoints": [
+        "./src/*.ts"
+    ],
+    "plugin": [
+        "typedoc-plugin-markdown",
+        "typedoc-github-wiki-theme"
+    ],
+    "out": "./docs",
+    "name": "arciera/server",
+    "theme": "github-wiki",
+}