chore: setup starlight-typedoc

This is currently broken due to HiDeoo/starlight-typedoc#23

To run example:

1. Clone repo
2. Checkout this branch (`boneskull/starlight-typedoc`)
3. Run `npm install`
4. Run `npm run dev:docs`

This should fail without any obvious error; this is because of the check for `groups` in `starlight-typedoc`.

You can also run `npm exec typedoc` from the workspace root to see that the problem is unique to `starlight-typedoc`.

package.json

@@ -23,8 +23,7 @@
     "build": "tsc -b",
     "clean": "tsc -b --clean",
     "dev": "tsc -b --watch",
-    "dev:docs": "npx docsify-cli serve docs",
-    "docs:build": "shx cp ./packages/midnight-smoker/README.md ./docs/README.md",
+    "dev:docs": "npm run -w packages/docs dev",
     "husky-install": "husky install",
     "lint": "run-p lint:eslint lint:md lint:deps",
     "lint:commit": "commitlint",

packages/docs/astro.config.ts

@@ -4,6 +4,7 @@ import {defineConfig} from 'astro/config';
 import path from 'node:path';
 import {fileURLToPath} from 'node:url';
 import remarkCodeImport from 'remark-code-import';
+import starlightTypeDocPlugin, {typeDocSidebarGroup} from 'starlight-typedoc';
 import {rehypeAutolink} from './plugin/rehype-autolink';
 
 const __filename = fileURLToPath(import.meta.url);
@@ -52,10 +53,25 @@ export default defineConfig({
             {label: 'Creating Reporters', link: '/developer/plugin-reporter'},
           ],
         },
+        typeDocSidebarGroup,
       ],
       components: {
         Footer: './src/components/Footer.astro',
       },
+      plugins: [
+        starlightTypeDocPlugin({
+          entryPoints: [
+            '../midnight-smoker',
+            '../plugin-default',
+            '../test-util',
+          ],
+          typeDoc: {
+            entryPointStrategy: 'packages',
+            plugin: ['typedoc-plugin-zod'],
+          },
+          tsconfig: '../../tsconfig.json',
+        }),
+      ],
     }),
   ],
   markdown: {

packages/docs/package.json

@@ -18,6 +18,10 @@
     "rehype-autolink-headings": "7.1.0",
     "remark-code-import": "1.2.0",
     "sharp": "0.32.6",
+    "starlight-typedoc": "0.7.0",
+    "typedoc": "0.25.4",
+    "typedoc-plugin-markdown": "4.0.0-next.38",
+    "typedoc-plugin-zod": "1.1.1",
     "unified": "11.0.4",
     "unist-util-visit": "5.0.0"
   },