From 3853d4e2ee2624a86cfa2756f09f5d2c8c4bd4e7 Mon Sep 17 00:00:00 2001 From: Will Eastcott Date: Sat, 9 Mar 2024 10:47:40 +0000 Subject: [PATCH 1/2] Remove JSDoc --- conf-api.json | 26 ----- package-lock.json | 272 +--------------------------------------------- package.json | 7 +- 3 files changed, 3 insertions(+), 302 deletions(-) delete mode 100644 conf-api.json diff --git a/conf-api.json b/conf-api.json deleted file mode 100644 index e81aca09093..00000000000 --- a/conf-api.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "plugins": [ - "plugins/markdown", - "./node_modules/jsdoc-tsimport-plugin/index.js", - "./node_modules/jsdoc-typeof-plugin" - ], - "recurseDepth": 10, - "source": { - "include": ["src"] - }, - "sourceType": "module", - "tags": { - "allowUnknownTags": true, - "dictionaries": ["jsdoc", "closure"] - }, - "templates": { - "cleverLinks": false, - "monospaceLinks": false - }, - "opts": { - "destination": "docs", - "encoding": "utf8", - "recurse": true, - "template": "./node_modules/@playcanvas/jsdoc-template" - } -} diff --git a/package-lock.json b/package-lock.json index dd7b8fff94a..3ac75c43f8b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "playcanvas", - "version": "1.69.0-dev", + "version": "1.70.0-dev", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "playcanvas", - "version": "1.69.0-dev", + "version": "1.70.0-dev", "license": "MIT", "dependencies": { "@types/webxr": "^0.5.7", @@ -19,7 +19,6 @@ "@babel/preset-env": "^7.23.2", "@playcanvas/canvas-mock": "^1.0.1", "@playcanvas/eslint-config": "^1.7.1", - "@playcanvas/jsdoc-template": "^1.1.2", "@rollup/plugin-babel": "^6.0.4", "@rollup/plugin-node-resolve": "^15.2.3", "@rollup/plugin-strip": "^3.0.4", @@ -29,9 +28,6 @@ "chai": "^4.3.10", "eslint": "^8.52.0", "fflate": "^0.8.1", - "jsdoc": "^4.0.2", - "jsdoc-tsimport-plugin": "^1.0.5", - "jsdoc-typeof-plugin": "^1.0.0", "karma": "^6.4.2", "karma-chrome-launcher": "^3.2.0", "karma-mocha": "2.0.1", @@ -1969,18 +1965,6 @@ "node": ">=4.2" } }, - "node_modules/@jsdoc/salty": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/@jsdoc/salty/-/salty-0.2.5.tgz", - "integrity": "sha512-TfRP53RqunNe2HBobVBJ0VLhK1HbfvBYeTC1ahnN64PWvyYyGebmMiPkuwvD9fpw2ZbkoPb8Q7mwy0aR8Z9rvw==", - "dev": true, - "dependencies": { - "lodash": "^4.17.21" - }, - "engines": { - "node": ">=v12.0.0" - } - }, "node_modules/@nicolo-ribaudo/eslint-scope-5-internals": { "version": "5.1.1-v1", "resolved": "https://registry.npmjs.org/@nicolo-ribaudo/eslint-scope-5-internals/-/eslint-scope-5-internals-5.1.1-v1.tgz", @@ -2044,15 +2028,6 @@ "eslint": ">= 4" } }, - "node_modules/@playcanvas/jsdoc-template": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@playcanvas/jsdoc-template/-/jsdoc-template-1.1.2.tgz", - "integrity": "sha512-MOPD3XwlN3c3Gp3Sboz2VZ3xhdeP0THH7V+3/0N6okb3uVmH07gCCwZ1kqWM7pzKZ8y5fth8B9fSB1ThzEf+Gw==", - "dev": true, - "dependencies": { - "handlebars": "^4.7.7" - } - }, "node_modules/@rollup/plugin-babel": { "version": "6.0.4", "resolved": "https://registry.npmjs.org/@rollup/plugin-babel/-/plugin-babel-6.0.4.tgz", @@ -2253,28 +2228,6 @@ "integrity": "sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==", "dev": true }, - "node_modules/@types/linkify-it": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-3.0.4.tgz", - "integrity": "sha512-hPpIeeHb/2UuCw06kSNAOVWgehBLXEo0/fUs0mw3W2qhqX89PI2yvok83MnuctYGCPrabGIoi0fFso4DQ+sNUQ==", - "dev": true - }, - "node_modules/@types/markdown-it": { - "version": "12.2.3", - "resolved": "https://registry.npmjs.org/@types/markdown-it/-/markdown-it-12.2.3.tgz", - "integrity": "sha512-GKMHFfv3458yYy+v/N8gjufHO6MSZKCOXpZc5GXIWWy8uldwfmPn98vp81gZ5f9SVw8YYBctgfJ22a2d7AOMeQ==", - "dev": true, - "dependencies": { - "@types/linkify-it": "*", - "@types/mdurl": "*" - } - }, - "node_modules/@types/mdurl": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@types/mdurl/-/mdurl-1.0.4.tgz", - "integrity": "sha512-ARVxjAEX5TARFRzpDRVC6cEk0hUIXCCwaMhz8y7S1/PxU6zZS1UMjyobz7q4w/D/R552r4++EhwmXK1N2rAy0A==", - "dev": true - }, "node_modules/@types/node": { "version": "20.8.8", "resolved": "https://registry.npmjs.org/@types/node/-/node-20.8.8.tgz", @@ -2673,12 +2626,6 @@ "node": ">=8" } }, - "node_modules/bluebird": { - "version": "3.7.2", - "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", - "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", - "dev": true - }, "node_modules/body-parser": { "version": "1.20.2", "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.2.tgz", @@ -2920,18 +2867,6 @@ } ] }, - "node_modules/catharsis": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz", - "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==", - "dev": true, - "dependencies": { - "lodash": "^4.17.15" - }, - "engines": { - "node": ">= 10" - } - }, "node_modules/chai": { "version": "4.3.10", "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.10.tgz", @@ -3668,15 +3603,6 @@ "integrity": "sha512-GHrMyVZQWvTIdDtpiEXdHZnFQKzeO09apj8Cbl4pKWy4i0Oprcq17usfDt5aO63swf0JOeMWjWQE/LzgSRuWpA==", "dev": true }, - "node_modules/entities": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-2.1.0.tgz", - "integrity": "sha512-hCx1oky9PFrJ611mf0ifBLBRW8lUUVRlFolb5gWRfIELabBlbp9xZvrqZLZAs+NxFnbfQoeGd8wDkygjg7U85w==", - "dev": true, - "funding": { - "url": "https://github.com/fb55/entities?sponsor=1" - } - }, "node_modules/es-abstract": { "version": "1.22.3", "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.22.3.tgz", @@ -4731,27 +4657,6 @@ "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", "dev": true }, - "node_modules/handlebars": { - "version": "4.7.8", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz", - "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==", - "dev": true, - "dependencies": { - "minimist": "^1.2.5", - "neo-async": "^2.6.2", - "source-map": "^0.6.1", - "wordwrap": "^1.0.0" - }, - "bin": { - "handlebars": "bin/handlebars" - }, - "engines": { - "node": ">=0.4.7" - }, - "optionalDependencies": { - "uglify-js": "^3.1.4" - } - }, "node_modules/has-bigints": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", @@ -5423,15 +5328,6 @@ "js-yaml": "bin/js-yaml.js" } }, - "node_modules/js2xmlparser": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.2.tgz", - "integrity": "sha512-6n4D8gLlLf1n5mNLQPRfViYzu9RATblzPEtm1SthMX1Pjao0r9YI9nw7ZIfRxQMERS87mcswrg+r/OYrPRX6jA==", - "dev": true, - "dependencies": { - "xmlcreate": "^2.0.4" - } - }, "node_modules/jscc": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/jscc/-/jscc-1.1.1.tgz", @@ -5457,41 +5353,6 @@ "sourcemap-codec": "^1.4.8" } }, - "node_modules/jsdoc": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.2.tgz", - "integrity": "sha512-e8cIg2z62InH7azBBi3EsSEqrKx+nUtAS5bBcYTSpZFA+vhNPyhv8PTFZ0WsjOPDj04/dOLlm08EDcQJDqaGQg==", - "dev": true, - "dependencies": { - "@babel/parser": "^7.20.15", - "@jsdoc/salty": "^0.2.1", - "@types/markdown-it": "^12.2.3", - "bluebird": "^3.7.2", - "catharsis": "^0.9.0", - "escape-string-regexp": "^2.0.0", - "js2xmlparser": "^4.0.2", - "klaw": "^3.0.0", - "markdown-it": "^12.3.2", - "markdown-it-anchor": "^8.4.1", - "marked": "^4.0.10", - "mkdirp": "^1.0.4", - "requizzle": "^0.2.3", - "strip-json-comments": "^3.1.0", - "underscore": "~1.13.2" - }, - "bin": { - "jsdoc": "jsdoc.js" - }, - "engines": { - "node": ">=12.0.0" - } - }, - "node_modules/jsdoc-tsimport-plugin": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/jsdoc-tsimport-plugin/-/jsdoc-tsimport-plugin-1.0.5.tgz", - "integrity": "sha512-6mvyF+tXdanf3zxEumTF9Uf/sXGlANP+XohSuiJiOVVWPGxi+3f2a2sy5Ew3W+0PMYUkcGYNxfYd5mMZsIHQpg==", - "dev": true - }, "node_modules/jsdoc-type-pratt-parser": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-4.0.0.tgz", @@ -5501,21 +5362,6 @@ "node": ">=12.0.0" } }, - "node_modules/jsdoc-typeof-plugin": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/jsdoc-typeof-plugin/-/jsdoc-typeof-plugin-1.0.0.tgz", - "integrity": "sha512-iG/LKaVnwRgi+EET6oi6uWNi+hVSUNM1t1NAywfCPIayDgsbQ4LWynnqO4IDTOPS7qObEWLJOjoqNby8+oiqXg==", - "dev": true - }, - "node_modules/jsdoc/node_modules/escape-string-regexp": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", - "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/jsesc": { "version": "2.5.2", "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", @@ -5788,15 +5634,6 @@ "json-buffer": "3.0.1" } }, - "node_modules/klaw": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz", - "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==", - "dev": true, - "dependencies": { - "graceful-fs": "^4.1.9" - } - }, "node_modules/levn": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", @@ -5810,15 +5647,6 @@ "node": ">= 0.8.0" } }, - "node_modules/linkify-it": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-3.0.3.tgz", - "integrity": "sha512-ynTsyrFSdE5oZ/O9GEf00kPngmOfVwazR5GKDq6EYfhlpFug3J2zybX56a2PRRpc9P+FuSoGNAwjlbDs9jJBPQ==", - "dev": true, - "dependencies": { - "uc.micro": "^1.0.1" - } - }, "node_modules/locate-path": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", @@ -6044,32 +5872,6 @@ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", "dev": true }, - "node_modules/markdown-it": { - "version": "12.3.2", - "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-12.3.2.tgz", - "integrity": "sha512-TchMembfxfNVpHkbtriWltGWc+m3xszaRD0CZup7GFFhzIgQqxIfn3eGj1yZpfuflzPvfkt611B2Q/Bsk1YnGg==", - "dev": true, - "dependencies": { - "argparse": "^2.0.1", - "entities": "~2.1.0", - "linkify-it": "^3.0.1", - "mdurl": "^1.0.1", - "uc.micro": "^1.0.5" - }, - "bin": { - "markdown-it": "bin/markdown-it.js" - } - }, - "node_modules/markdown-it-anchor": { - "version": "8.6.7", - "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-8.6.7.tgz", - "integrity": "sha512-FlCHFwNnutLgVTflOYHPW2pPcl2AACqVzExlkGQNsi4CJgqOHN7YTgDd4LuhgN1BFO3TS0vLAruV1Td6dwWPJA==", - "dev": true, - "peerDependencies": { - "@types/markdown-it": "*", - "markdown-it": "*" - } - }, "node_modules/marked": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", @@ -6082,12 +5884,6 @@ "node": ">= 12" } }, - "node_modules/mdurl": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", - "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==", - "dev": true - }, "node_modules/media-typer": { "version": "0.3.0", "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", @@ -6166,18 +5962,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true, - "bin": { - "mkdirp": "bin/cmd.js" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/mocha": { "version": "10.2.0", "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.2.0.tgz", @@ -6463,12 +6247,6 @@ "node": ">= 0.6" } }, - "node_modules/neo-async": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", - "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", - "dev": true - }, "node_modules/nise": { "version": "5.1.5", "resolved": "https://registry.npmjs.org/nise/-/nise-5.1.5.tgz", @@ -7119,15 +6897,6 @@ "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", "dev": true }, - "node_modules/requizzle": { - "version": "0.2.4", - "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.4.tgz", - "integrity": "sha512-JRrFk1D4OQ4SqovXOgdav+K8EAhSB/LJZqCz8tbX0KObcdeM15Ss59ozWMBWmmINMagCwmqn4ZNryUGpBsl6Jw==", - "dev": true, - "dependencies": { - "lodash": "^4.17.21" - } - }, "node_modules/resolve": { "version": "1.22.8", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", @@ -8225,25 +7994,6 @@ "node": "*" } }, - "node_modules/uc.micro": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", - "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", - "dev": true - }, - "node_modules/uglify-js": { - "version": "3.17.4", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", - "integrity": "sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==", - "dev": true, - "optional": true, - "bin": { - "uglifyjs": "bin/uglifyjs" - }, - "engines": { - "node": ">=0.8.0" - } - }, "node_modules/unbox-primitive": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", @@ -8259,12 +8009,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/underscore": { - "version": "1.13.6", - "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.6.tgz", - "integrity": "sha512-+A5Sja4HP1M08MaXya7p5LvjuM7K6q/2EaC0+iovj/wOcMsTzMvDFbasi/oSapiwOlt252IqsKqPjCl7huKS0A==", - "dev": true - }, "node_modules/undici-types": { "version": "5.25.3", "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.25.3.tgz", @@ -8505,12 +8249,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/wordwrap": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", - "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", - "dev": true - }, "node_modules/workerpool": { "version": "6.2.1", "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.2.1.tgz", @@ -8609,12 +8347,6 @@ "node": ">= 6" } }, - "node_modules/xmlcreate": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.4.tgz", - "integrity": "sha512-nquOebG4sngPmGPICTS5EnxqhKbCmz5Ox5hsszI2T6U5qdrJizBc+0ilYSEjTSzU0yZcmvppztXe/5Al5fUwdg==", - "dev": true - }, "node_modules/y18n": { "version": "5.0.8", "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", diff --git a/package.json b/package.json index 588cd6ef54e..5e8be3aa806 100644 --- a/package.json +++ b/package.json @@ -113,7 +113,6 @@ "@babel/preset-env": "^7.23.2", "@playcanvas/canvas-mock": "^1.0.1", "@playcanvas/eslint-config": "^1.7.1", - "@playcanvas/jsdoc-template": "^1.1.2", "@rollup/plugin-babel": "^6.0.4", "@rollup/plugin-node-resolve": "^15.2.3", "@rollup/plugin-strip": "^3.0.4", @@ -123,9 +122,6 @@ "chai": "^4.3.10", "eslint": "^8.52.0", "fflate": "^0.8.1", - "jsdoc": "^4.0.2", - "jsdoc-tsimport-plugin": "^1.0.5", - "jsdoc-typeof-plugin": "^1.0.0", "karma": "^6.4.2", "karma-chrome-launcher": "^3.2.0", "karma-mocha": "2.0.1", @@ -167,8 +163,7 @@ "watch:es5": "npm run build:es5 -- -w", "watch:es6": "npm run build:es6 -- -w", "watch:profiler": "npm run build:profiler -- -w", - "docs": "jsdoc -c conf-api.json", - "typedocs": "typedoc", + "docs": "typedoc", "lint": "eslint --ext .js,.mjs extras scripts src test utils rollup.config.mjs", "serve": "serve build -l 51000", "test": "mocha --recursive --require test/fixtures.mjs", From e3d71c918d7ccea16b36e95261ff9dd1dc472aa6 Mon Sep 17 00:00:00 2001 From: Will Eastcott Date: Sat, 9 Mar 2024 10:53:29 +0000 Subject: [PATCH 2/2] Update READMEs --- .gitignore | 1 - README-ja.md | 8 ++++---- README-kr.md | 8 ++++---- README-zh.md | 8 ++++---- README.md | 8 ++++---- tsconfig.json | 1 - 6 files changed, 16 insertions(+), 18 deletions(-) diff --git a/.gitignore b/.gitignore index fed9deb96d4..3fb2535ed6b 100644 --- a/.gitignore +++ b/.gitignore @@ -11,7 +11,6 @@ npm-debug.log scripts/parsers/vox-parser.js scripts/parsers/vox-parser.js.map types -typedocs stats.html .npmrc examples/.npmrc diff --git a/README-ja.md b/README-ja.md index e0c9c14826f..391a1dc4cc8 100644 --- a/README-ja.md +++ b/README-ja.md @@ -111,10 +111,10 @@ npm install これで、様々なオプションでビルドを実行できるようになりました。 -| コマンド | 説明 | 出力先 | -| ----------------------- | -------------------------------------------------- | ---------- | -| `npm run build` | すべてのエンジンビルドターゲットと型宣言をビルドする | `build` | -| `npm run typedocs` | エンジンの[APIリファレンスドキュメント][docs]をビルドする | `typedocs` | +| コマンド | 説明 | 出力先 | +| --------------- | ----------------------------------------------------- | ---------- | +| `npm run build` | すべてのエンジンビルドターゲットと型宣言をビルドする | `build` | +| `npm run docs` | エンジンの[APIリファレンスドキュメント][docs]をビルドする | `docs` | ## PlayCanvasエディター diff --git a/README-kr.md b/README-kr.md index d45e04f2d02..fd584d6911c 100644 --- a/README-kr.md +++ b/README-kr.md @@ -112,10 +112,10 @@ npm install 이제 다양한 빌드 옵션을 실행할 수 있습니다. -| 명령어 | 설명 | 출력 위치 | -| ----------------------- | --------------------------------------------------- | ---------- | -| `npm run build` | 모든 엔진 빌드 대상과 타입 선언을 빌드합니다 | `build` | -| `npm run typedocs` | 엔진 [API 참조 문서][docs]를 빌드합니다 | `typedocs` | +| 명령어 | 설명 | 출력 위치 | +| --------------- | ----------------------------------------- | ---------- | +| `npm run build` | 모든 엔진 빌드 대상과 타입 선언을 빌드합니다 | `build` | +| `npm run docs` | 엔진 [API 참조 문서][docs]를 빌드합니다 | `docs` | ## PlayCanvas 에디터 diff --git a/README-zh.md b/README-zh.md index 32ffe176453..09f4046ed52 100644 --- a/README-zh.md +++ b/README-zh.md @@ -110,10 +110,10 @@ npm install 现在您就可以运行不同的搭建选项了： -| 命令 | 描述 | 输出到 | -| ----------------------- | ------------------------------------------------ | ---------- | -| `npm run build` | 构建所有引擎构建目标和类型声明 | `build` | -| `npm run typedocs` | 构建引擎[API参考文档][docs] | `typedocs` | +| 命令 | 描述 | 输出到 | +| --------------- | --------------------------- | ---------- | +| `npm run build` | 构建所有引擎构建目标和类型声明 | `build` | +| `npm run docs` | 构建引擎[API参考文档][docs] | `docs` | ## PlayCanvas 平台 diff --git a/README.md b/README.md index 1fcdb5c85a4..f54a877ad51 100644 --- a/README.md +++ b/README.md @@ -108,10 +108,10 @@ npm install Now you can run various build options: -| Command | Description | Outputs To | -| ----------------------- | ---------------------------------------------- | ---------- | -| `npm run build` | Build all engine flavors and type declarations | `build` | -| `npm run typedocs` | Build engine [API reference docs][docs] | `typedocs` | +| Command | Description | Outputs To | +| --------------- | ---------------------------------------------- | ---------- | +| `npm run build` | Build all engine flavors and type declarations | `build` | +| `npm run docs` | Build engine [API reference docs][docs] | `docs` | ## PlayCanvas Editor diff --git a/tsconfig.json b/tsconfig.json index 553916606e0..1c42a1a9f81 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -53,7 +53,6 @@ "Forum": "https://forum.playcanvas.com/", "GitHub": "https://github.com/playcanvas/engine" }, - "out": "typedocs", "plugin": [ "./utils/typedoc-plugin.mjs", "typedoc-plugin-mdn-links"