typedoc

.github/workflows/doc.yml

@@ -0,0 +1,49 @@
+name: Deploy docs
+
+on:
+  push:
+    branches: ["master"]
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: "npm"
+      - run: npm ci
+      - run: npm run doc
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: doc
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -15,6 +15,7 @@ dist-ssr
 *.d.ts
 !/src/vite-env.d.ts
 !/examples/src/vite-env-override.d.ts
+/doc
 
 # Editor directories and files
 .vscode/*

package.json

@@ -14,7 +14,8 @@
     "build": "tsc && vite build",
     "dev": "vite -c examples/vite.config.ts",
     "format:check": "prettier --check .",
-    "format:fix": "prettier --write ."
+    "format:fix": "prettier --write .",
+    "doc": "typedoc"
   },
   "files": [
     "*.js",
@@ -30,6 +31,7 @@
     "@types/three": "^0.152.1",
     "prettier": "^2.8.8",
     "rimraf": "^5.0.1",
+    "typedoc": "^0.24.8",
     "typescript": "^5.0.2",
     "vite": "^4.3.9",
     "vite-plugin-dts": "^3.2.0",

typedoc.config.cjs

@@ -0,0 +1,23 @@
+// @ts-check
+
+const fs = require("fs");
+const path = require("path");
+
+/**
+ *
+ * @param {string} root
+ * @returns
+ */
+function listFiles(root) {
+  return fs
+    .readdirSync(root)
+    .map((entry) => path.join(root, entry))
+    .filter((entry) => fs.statSync(entry).isFile());
+}
+
+/** @type {import('typedoc').TypeDocOptions} */
+module.exports = {
+  entryPoints: [...listFiles("src"), ...listFiles("src/util")],
+  basePath: "src",
+  out: "doc",
+};