Automatically generate website using TypeDoc

.github/workflows/deploy.yml

@@ -0,0 +1,43 @@
+name: Deploy playground
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+
+concurrency:
+  group: "deploy"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Build documentation
+        run: npm run build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1 +1,2 @@
 node_modules
+docs

README.md

@@ -4,6 +4,8 @@ Scratch doesn't provide type definitions for their libraries, so we wrote our ow
 
 This repository only contains types for the vanilla (LLK) Scratch runtime and editor. For the additional types in the TurboWarp runtimes, see [@turbowarp/types-tw](https://github.com/TurboWarp/types-tw).
 
+A possibly more human-readable version of the TypeScript definitions can be found at: https://turbowarp.github.io/types/
+
 |Module|Status|
 |:-:|:-:|
 |scratch-vm|✅|

package.json

@@ -12,7 +12,8 @@
   },
   "scripts": {
     "test": "tsc",
-    "watch": "tsc -w"
+    "watch": "tsc -w",
+    "build": "typedoc types/*"
   },
   "repository": {
     "type": "git",
@@ -24,8 +25,8 @@
     "url": "https://github.com/TurboWarp/types/issues"
   },
   "homepage": "https://github.com/TurboWarp/types#readme",
-  "dependencies": {},
   "devDependencies": {
+    "typedoc": "^0.25.12",
     "typescript": "^4.7.4"
   }
 }