ci(docs): Added theme to docs generator

package.json

@@ -24,11 +24,11 @@
   },
   "main": "dist/index.js",
   "scripts": {
-    "build": "tsc && typedoc",
+    "build": "tsc",
     "lint": "eslint --cache .",
     "typecheck": "tsc --noEmit",
     "format:check": "prettier --check .",
-    "check": "pnpm lint && pnpm typecheck && pnpm format:check",
+    "check": "pnpm lint && pnpm typecheck",
     "prepare": "husky",
     "docs:generate": "typedoc"
   },
@@ -49,6 +49,7 @@
     "typedoc-plugin-inline-sources": "^1.2.1",
     "typedoc-plugin-mdn-links": "^5.0.1",
     "typedoc-plugin-zod": "^1.4.0",
+    "typedoc-github-theme": "^0.2.1",
     "typescript": "^5.5.3",
     "typescript-eslint": "^8.26.0"
   },

pnpm-lock.yaml

@@ -8,6 +8,9 @@ importers:
 
   .:
     dependencies:
+      typedoc-github-theme:
+        specifier: ^0.2.1
+        version: 0.2.1(typedoc@0.27.9(typescript@5.8.2))
       zod:
         specifier: ^3.24.2
         version: 3.24.2
@@ -750,6 +753,12 @@ packages:
     resolution: {integrity: sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==}
     engines: {node: '>= 0.8.0'}
 
+  typedoc-github-theme@0.2.1:
+    resolution: {integrity: sha512-pOgsS9CVAOO3JxQ1V0ocDkrPCULpoWg1OzRmn/mOlyG+vEYwUAp5DAoKrGECdNIomycxcisc8ovcMX0nHDgWTA==}
+    engines: {node: '>=18.0.0'}
+    peerDependencies:
+      typedoc: ^0.27.6
+
   typedoc-plugin-coverage@3.4.1:
     resolution: {integrity: sha512-V23DAwinAMpGMGcL1R1s8Snr26hrjfIdwGf+4jR/65ZdmeAN+yRX0onfx5JlembTQhR6AePQ/parfQNS0AZ64A==}
     engines: {node: '>= 18'}
@@ -1525,6 +1534,10 @@ snapshots:
     dependencies:
       prelude-ls: 1.2.1
 
+  typedoc-github-theme@0.2.1(typedoc@0.27.9(typescript@5.8.2)):
+    dependencies:
+      typedoc: 0.27.9(typescript@5.8.2)
+
   typedoc-plugin-coverage@3.4.1(typedoc@0.27.9(typescript@5.8.2)):
     dependencies:
       typedoc: 0.27.9(typescript@5.8.2)

typedoc.config.mjs

@@ -19,12 +19,11 @@ const config = {
     "typedoc-plugin-zod",
     "typedoc-plugin-include-example",
     "@shipgirl/typedoc-plugin-versions",
+    "typedoc-github-theme",
   ],
-  footerTypedocVersion: true,
-  footerLastModified: true,
-  coverageLabel: "Docs Coverage",
-  coverageOutputType: "all",
-  coverageSvgWidth: 130,
+  customFooterHtml: '<p class="tsd-generator" style="display: inline-flex; flex-direction: row; justify-content: space-around; width: 100%;"> <span> Made with ❤ by <a href="https://b00tload.space">Alix von Schirp</a> @ <a href="https://github.com/cis-oss">CISLabs OSS</a> </span> <span> <a href="https://github.com/cis-oss/pushover" target="_blank">GitHub</a> | <a href="https://github.com/cis-oss/pushover/issues" target="_blank">Issues</a> | <a href="https://github.com/cis-oss/pushover/blob/main/LICENSE" target="_blank">License</a> </span> <span>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc </a> with <a href="https://github.com/JulianWowra/typedoc-github-theme" target="_blank">typedoc-github-theme</a></span></p>',
+  coverageOutputType: "json",
+  hideGenerator: true,
 };
 
 export default config;