add typedoc-plugin-extras

* Set docs favicon * Include typedoc version in footer * Include generation date + time in footer
NxtLvLSoftware · Sep 13, 2023 · d27149c · d27149c
1 parent 111728c
commit d27149c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -15,8 +15,8 @@
     "build": "tsc --inlineSourceMap --removeComments -p ./",
     "build-ci": "tsc --pretty false --inlineSourceMap --removeComments --listEmittedFiles -p ./",
     "dev": "tsc --watch -p ./",
-    "docs": "npx typedoc --out docs-build --cacheBust index.ts",
-    "docs-ci": "npx typedoc --gitRemote dist --out docs-build --cacheBust index.ts"
+    "docs": "npx typedoc --plugin typedoc-plugin-extras --out docs-build --cacheBust index.ts",
+    "docs-ci": "npx typedoc --plugin typedoc-plugin-extras --gitRemote dist --out docs-build --cacheBust index.ts"
   },
   "keywords": [
     "alpine",
@@ -31,6 +31,7 @@
   },
   "devDependencies": {
     "typedoc": "^0.25.1",
+    "typedoc-plugin-extras": "^3.0.0",
     "typescript": "^5.1.6"
   }
 }
diff --git a/typedoc.json b/typedoc.json
@@ -1,4 +1,8 @@
 {
+  "favicon": "https://nxtlvlsoftware.github.io/alpine-typescript/favicon.ico",
+  "footerTypedocVersion": true,
+  "footerDate": true,
+  "footerTime": true,
   "sidebarLinks": {
     "GitHub": "https://github.com/NxtLvlSoftware/alpine-typescript",
     "Twitter": "https://twitter.com/NxtLvlSoftware",