fix typedoc

.gitignore

@@ -5,4 +5,9 @@ dist/
 .idea/
 
 # Dependency directories
-node_modules/
+node_modules/
+docs/
+
+**/tsconfig.tsbuildinfo
+
+*.cache

package.json

@@ -7,10 +7,12 @@
   "scripts": {
     "build": "npm run build --workspace=quarks.core --workspace=three.quarks --workspace=quarks.nodes",
     "dev": "npm run dev --workspace=quarks.core --workspace=three.quarks --workspace=quarks.nodes",
-    "test": "npm run test  --workspace=quarks.core --workspace=three.quarks --workspace=quarks.nodes ",
+    "test": "npm run test  --workspace=quarks.core --workspace=three.quarks --workspace=quarks.nodes",
     "example": "npm run example --workspace=three.quarks",
     "prettier": "npm run prettier --workspace=quarks.core --workspace=three.quarks --workspace=quarks.nodes",
-    "docs": "npm run docs --workspace=quarks.core --workspace=three.quarks --workspace=quarks.nodes"
+    "publish": "npm run publish --workspace=quarks.core --workspace=three.quarks",
+    "docs": "typedoc",
+    "docs-dev": "http-server ./docs -c-1 -p 8001"
   },
   "devDependencies": {
     "@babel/core": "^7.24.7",
@@ -42,7 +44,7 @@
     "rollup": "^3.29.4",
     "ts-jest": "^29.1.4",
     "tslib": "^2.6.3",
-    "typedoc": "^0.25.13",
+    "typedoc": "^0.26.2",
     "typedoc-google-tag-manager-plugin": "^1.0.5",
     "typedoc-plugin-extra-footer": "^1.0.1",
     "typedoc-plugin-markdown": "^4.0.3",

packages/quarks.core/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Forrest Sun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/quarks.core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "quarks.core",
   "version": "0.13.1",
-  "description": "Core library for quarks VFX Engine",
+  "description": "Core library for Quarks VFX / Particle System Library",
   "type": "module",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/quarks.core.cjs",
@@ -13,6 +13,11 @@
       "types": "./dist/types/index.d.ts"
     }
   },
+  "files": [
+    "dist",
+    "src",
+    "LICENSE"
+  ],
   "scripts": {
     "build:types": "tsc --emitDeclarationOnly",
     "build:js": "cross-env NODE_ENV=production rollup -c",
@@ -37,5 +42,5 @@
   "bugs": {
     "url": "https://github.com/Alchemist0823/three.quarks/issues"
   },
-  "homepage": "https://github.com/Alchemist0823/three.quarks#readme"
+  "homepage": "https://quarks.art"
 }

packages/quarks.core/tsconfig.json

@@ -3,8 +3,10 @@
   "compilerOptions": {
     "declarationDir": "./dist/types",
     "typeRoots": ["./types", "./node_modules/@types", "../../node_modules/@types"],
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "rootDir": "src",
+    "outDir": "dist"
   },
   "include": ["src", "types"],
-  "exclude": ["node_modules", "test", "dist"]
+  "exclude": ["node_modules/", "test/", "dist/"]
 }

packages/quarks.core/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.package.json"],
+  "entryPoints": ["src/index.ts"]
+}

packages/quarks.nodes/tsconfig.json

@@ -4,7 +4,9 @@
     "declarationDir": "./dist/types",
     "typeRoots": ["./node_modules/@webgpu/types" ,"./types", "./node_modules/@types", "../../node_modules/@types"],
     "skipLibCheck": true,
+    "rootDir": "src",
+    "outDir": "dist"
   },
   "include": ["src", "types"],
-  "exclude": ["node_modules", "test", "dist"]
+  "exclude": ["node_modules/", "test/", "dist/"]
 }

packages/three.quarks/package.json

@@ -17,7 +17,6 @@
   "files": [
     "dist",
     "src",
-    "README.md",
     "LICENSE"
   ],
   "scripts": {
@@ -32,8 +31,6 @@
     "lint": "eslint . --ext .ts",
     "prepublishOnly": "npm run build:production",
     "deploy": "gh-pages -d examples",
-    "docs": "typedoc",
-    "docs-dev": "http-server ./docs -c-1 -p 8001",
     "example": "http-server ./examples -c-1 -p 8000",
     "test": "jest",
     "test:coverage": "jest --coverage",
@@ -58,7 +55,7 @@
   "bugs": {
     "url": "https://github.com/Alchemist0823/three.quarks/issues"
   },
-  "homepage": "https://github.com/Alchemist0823/three.quarks#readme",
+  "homepage": "https://quarks.art",
   "peerDependencies": {
     "three": ">=0.165.0"
   },

packages/three.quarks/tsconfig.json

@@ -2,8 +2,11 @@
   "extends": ["../../tsconfig.package.json"],
   "compilerOptions": {
     "declarationDir": "./dist/types",
-    "typeRoots": ["./types", "./node_modules/@types", "../../node_modules/@types"]
+    "rootDir": "src",
+    "outDir": "dist",
+    "typeRoots": ["./types", "./node_modules/@types", "../../node_modules/@types"],
+    "skipLibCheck": true
   },
   "include": ["src", "types"],
-  "exclude": ["node_modules", "test", "dist"]
+  "exclude": ["node_modules/", "test/", "dist/"]
 }

packages/three.quarks/typedoc.json

@@ -1,19 +1,4 @@
 {
-  "$schema": "https://typedoc.org/schema.json",
-  "includeVersion": true,
-  "entryPoints": ["src/index.ts"],
-  "out": "docs",
-  "excludeInternal": true,
-  "excludePrivate": true,
-  "readme": "./README.md",
-  "scriptSrc": "https://github.com/Alchemist0823/three.quarks/",
-  "plugin": ["typedoc-plugin-script-inject", "typedoc-plugin-extra-footer", "typedoc-google-tag-manager-plugin"],
-  "customCss": "./assets/custom.css",
-  "navigationLinks": {
-    "GitHub": "https://github.com/Alchemist0823/three.quarks"
-  },
-  "extraFooter": "<div class=\"copyright\">&copy; 2024 <a href=\"https://quarks.art/\">Quarks VFX, LLC</a></div>",
-  "extraFooterNoDefaultWrapper": true,
-  "hideGenerator": true,
-  "gtmWorkspaceId": "G-Q0RV7V5Y83"
+  "extends": ["../../typedoc.package.json"],
+  "entryPoints": ["src/index.ts"]
 }

tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "references": [
+    { "path": "packages/three.quarks" },
+    { "path": "packages/quarks.core" }
+  ]
+}