Add typedoc-plugin-extras plugin

playcanvas · Jan 23, 2024 · 1534059 · 1534059
1 parent 1a21c52
commit 1534059
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 1 deletion.
diff --git a/favicon.ico b/favicon.ico
diff --git a/package-lock.json b/package-lock.json
diff --git 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
@@ -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",