pl-api: improve docs

Signed-off-by: marcin mikołajczak <git@mkljczk.pl>

.github/workflows/pl-fe.yaml

@@ -65,7 +65,7 @@ jobs:
 
     - name: Build pl-api documentation
       working-directory: ./packages/pl-api
-      run: npx typedoc lib/main.ts
+      run: npx typedoc
 
     - name: Copy pl-api documentation
       working-directory: ./packages/pl-api

packages/pl-api/package.json

@@ -32,6 +32,7 @@
     "eslint-plugin-promise": "^6.0.0",
     "typedoc": "^0.26.10",
     "typedoc-material-theme": "^1.1.0",
+    "typedoc-plugin-valibot": "^1.0.0",
     "typescript": "^5.6.2",
     "vite": "^5.4.8",
     "vite-plugin-dts": "^4.2.3"

packages/pl-api/typedoc.config.mjs

@@ -0,0 +1,9 @@
+/** @type {Partial<import('typedoc').TypeDocOptions>} */
+
+const config = {
+  entryPoints: ['./lib/main.ts'],
+  plugin: ['typedoc-material-theme', 'typedoc-plugin-valibot'],
+  themeColor: '#d80482',
+};
+
+export default config;

packages/pl-api/typedoc.js

@@ -1,5 +0,0 @@
-export default {
-  plugin: ['typedoc-material-theme'],
-  themeColor: '#d80482',
-};
-

packages/pl-api/yarn.lock

@@ -2758,6 +2758,11 @@ typedoc-material-theme@^1.1.0:
   dependencies:
     "@material/material-color-utilities" "^0.2.7"
 
+typedoc-plugin-valibot@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/typedoc-plugin-valibot/-/typedoc-plugin-valibot-1.0.0.tgz#9a7e586d993f5e6c9efe60ab12724e4fb24f7efe"
+  integrity sha512-3LJSPc/aAKvxsfJx3/qgI1HBJvh4JNmtQYzcbxiQrVdiloIQwh4g0KtwvHV9CCl6gAnDxdnFMdE5gbhne2wXuw==
+
 typedoc@^0.26.10:
   version "0.26.10"
   resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.26.10.tgz#d372f171dc2c4458cbac6c473be9591042ab781d"