Setup typedoc for plugins.

.github/workflows/deploy-pages.yml

@@ -46,6 +46,8 @@ jobs:
     - run: npm run docs
     - run: mkdir _site
     - run: mv -t _site docs dist examples README.md LICENSE index.html
+    - run: mkdir -p _site/plugins
+    - run: find plugins -maxdepth 2 -type d \( -name dist -o -name docs \) -exec sh -c "mkdir -p _site/{} && cp -r {}/ _site/{}/" \;
     - name: Setup Pages
       uses: actions/configure-pages@v3
     - name: Upload artifact

package.json

@@ -40,7 +40,9 @@
     "dist",
     "src",
     "examples",
-    "plugins",
+    "plugins/*/dist",
+    "plugins/*/src",
+    "plugins/*/tsconfig.json",
     "tsconfig.json"
   ],
   "repository": {

plugins/tweakpane-editor/package.json

@@ -37,7 +37,8 @@
         "new:publish": "npm run prepare && clean-package && npm publish --access public && clean-package restore",
         "prepare": "npm run build",
         "build": "rimraf dist && NODE_ENV=production rollup -c",
-        "dev": "rollup -c -w"
+        "dev": "rollup -c -w",
+        "docs": "rimraf docs && npx typedoc"
     },
     "author": "repalash <palash@shaders.app>",
     "license": "Apache-2.0",

plugins/tweakpane-editor/typedoc.json

@@ -0,0 +1,10 @@
+{
+    "extends": [
+        "../../typedoc.json"
+    ],
+    "entryPoints": [
+        "src/index.ts"
+    ],
+    "name": "Threepipe Tweakpane Editor Plugin",
+    "readme": "none"
+}

plugins/tweakpane/package.json

@@ -23,7 +23,8 @@
         "new:publish": "npm run prepare && clean-package && npm publish --access public && clean-package restore",
         "prepare": "npm run build",
         "build": "rimraf dist && NODE_ENV=production rollup -c",
-        "dev": "rollup -c -w"
+        "dev": "rollup -c -w",
+        "docs": "rimraf docs && npx typedoc"
     },
     "author": "repalash <palash@shaders.app>",
     "license": "Apache-2.0",

plugins/tweakpane/typedoc.json

@@ -0,0 +1,10 @@
+{
+    "extends": [
+        "../../typedoc.json"
+    ],
+    "entryPoints": [
+        "src/index.ts"
+    ],
+    "name": "Threepipe Tweakpane Plugin",
+    "readme": "none"
+}

scripts/build-plugins.mjs

@@ -2,3 +2,4 @@ import {execEachPlugin} from "./utils.mjs";
 
 // Each plugin should have "prepare" that will also build the plugin
 execEachPlugin('npm install') // install dependencies
+execEachPlugin('npm run docs')

tsconfig.json

@@ -30,7 +30,7 @@
         "plugins": [{ "name": "typescript-plugin-css-modules" }]
     },
     "include": [
-        "./src/**/*",
+        "src/**/*",
         "node_modules/@types/wicg-file-system-access/index.d.ts"
     ],
     "exclude": [

typedoc.json

@@ -11,6 +11,9 @@
         },
         "uiconfig.js": {
             "*": "https://repalash.com/uiconfig.js"
+        },
+        "uiconfig-tweakpane": {
+            "*": "https://repalash.com/uiconfig-tweakpane"
         }
     },
     "entryPoints": ["src/index.ts"],