From 1534059cac7b1abcc34e4bf5587ee2ef6377603e Mon Sep 17 00:00:00 2001 From: Will Eastcott Date: Tue, 23 Jan 2024 12:15:25 +0000 Subject: [PATCH] Add typedoc-plugin-extras plugin --- favicon.ico | Bin 0 -> 4286 bytes package-lock.json | 10 ++++++++++ package.json | 1 + tsconfig.json | 9 ++++++++- 4 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 favicon.ico diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..9fa56e0648f03bf273409dc5b7bac4d204975dcf GIT binary patch literal 4286 zcmds5ZA@EL7(Q%K+{|LNLgxheYKtTqqtPrIMg<)L!LhPsgKiWUv}LPdOZ10kQ4+tR zOPBqaI!TN_T>SVUX2y?1e`pq?Ceyf$;$TByT`2=*d++VN{TNsu-*fAQb|m|A+nMY( z_nzBx+dl7k-uHRllQNb^uhLS+uk2F;V}*>dd+DSp_5_`LUOniU@z&ItnqaJ=N5l zx45IQxMi$t@Pj=z1p6z0Vsbi$zJVC>n!-85H@jq164!=pGhiEhxUX{_AGbxX*9W(ur&2sQgh@x!Tz2DdnlUrNGpNC9gI!LUQ181&b^ z*(rkOdPV(3R5^z6;kTC;@wA)70?_~QJPO(buuUP{({(vQuxTSl5%-6G)SV~Pfs zF@E=Jgz|9~?2#Z$jworKyeEsAFY6Z7Jhr?Z#g`{(p;sMe{Rz0de%!u!i1c?J#hrp$ zpA|h4#i2j{W?D<7Tg0jsTIbUu8v13N@GXzyd?102HzvRyr#R{^z~Yj?>qajZ7Iy?C zT_LQjABV|)8F|fAUri!<-&Qau{&N)@z}LSBc(B_C!`2}AQdBp7QKy85_Q`O1FQUN4 z*EWgbF5;p-qSo2L!T7Qm_(a`-F!F8s`8T$Pala>}HQ%^`+WqIi)}O%|+Z2p;;$joU z*C%1{rz;t8xQ~$kkPh|oe7@VWh>Xbh#har7zzBX z#^E_ib6N1eLh`T@(({#tC43H`#FKboAOJ%X<%D`(5!F3wlwoWWap?0nc6t@8*`}ZW z^8fT#`(gw?k1VhIv8gz=_mdx2pTOh;jxQD3;o}Lauap+JCbG5HNXOOg zjg-p=o|V)!bN|`+JkiKWm@O#aP@as{N(yprY>SR?wcF=hu?O9A7JL c&OP`4o5}l%$WwC3^|j)-QJ-o51N>j(zmD33P5=M^ literal 0 HcmV?d00001 diff --git a/package-lock.json b/package-lock.json index 581ae8b..d00f610 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15,6 +15,7 @@ "react": "^18.2.0", "serve": "^14.2.1", "typedoc": "^0.25.7", + "typedoc-plugin-extras": "^3.0.0", "typedoc-plugin-mdn-links": "^3.1.13", "typedoc-plugin-rename-defaults": "^0.7.0" } @@ -1086,6 +1087,15 @@ "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x" } }, + "node_modules/typedoc-plugin-extras": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-extras/-/typedoc-plugin-extras-3.0.0.tgz", + "integrity": "sha512-eiAe3qtm2WbV5owdncpt0zHZPqsNZH2mzNGILPd4zqrvEZie3Et9es4cpGZ+8lHO/SI0pVKwsAj7IuMxPNOdYg==", + "dev": true, + "peerDependencies": { + "typedoc": "0.25.x" + } + }, "node_modules/typedoc-plugin-mdn-links": { "version": "3.1.13", "resolved": "https://registry.npmjs.org/typedoc-plugin-mdn-links/-/typedoc-plugin-mdn-links-3.1.13.tgz", diff --git a/package.json b/package.json index 98573bd..c467777 100644 --- a/package.json +++ b/package.json @@ -26,6 +26,7 @@ "react": "^18.2.0", "serve": "^14.2.1", "typedoc": "^0.25.7", + "typedoc-plugin-extras": "^3.0.0", "typedoc-plugin-mdn-links": "^3.1.13", "typedoc-plugin-rename-defaults": "^0.7.0" }, diff --git a/tsconfig.json b/tsconfig.json index c1548ed..0b4c564 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -60,11 +60,18 @@ "GitHub": "https://github.com/playcanvas" }, "plugin": [ + "typedoc-plugin-extras", "typedoc-plugin-mdn-links", "typedoc-plugin-rename-defaults" ], "readme": "INDEX.md", - "sortEntryPoints": false + "sortEntryPoints": false, + + // Options for typedoc-plugin-extras + "customDescription": "Combined API reference manual for PlayCanvas", + "favicon": "favicon.ico", + "footerLastModified": true, + "footerTypedocVersion": true }, "include": [ "submodules/editor-api/**/*.js",