vike-plugin-typedoc 0.0.1

package/README.md

@@ -0,0 +1,148 @@
+# vike-plugin-typedoc
+
+Headless TypeDoc integration for Vike documentation sites.
+
+## Installation
+
+```bash
+npm install vike-plugin-typedoc
+```
+
+Peer dependencies:
+
+- `vike >= 0.4.250`
+- `vike-react >= 0.5` (if you use the React hooks)
+- `react >= 18` (if you use the React hooks)
+
+## What It Does
+
+- Loads TypeDoc JSON files into a cached `TypedocContext`.
+- Builds package and symbol URLs (default `/api/:pkg/:symbol`).
+- Builds API navigation trees.
+- Pre-renders markdown fields and auto-links type references.
+- Provides Vike data helpers (`withApiPackage`, `withApiExport`) and React hooks (`useApiPackage`, `useApiExport`).
+- Provides a Vike config extension that auto-loads context and prerender URLs.
+
+## Quick Start
+
+Add the plugin extension and `typedoc` config:
+
+```ts
+import { join } from 'node:path';
+import vikePluginTypedoc from 'vike-plugin-typedoc/config';
+import vikeReact from 'vike-react/config';
+import type { Config } from 'vike/types';
+
+const root = process.cwd();
+
+export default {
+  extends: [vikeReact, vikePluginTypedoc],
+  prerender: true,
+  typedoc: {
+    typedocDir: join(root, '.typedoc'),
+    packagesDir: join(root, 'packages'),
+    basePath: '/api',
+  },
+} satisfies Config;
+```
+
+The plugin expects one TypeDoc JSON file per package slug in `typedocDir` (for example `.typedoc/devkit.json`).
+
+## Package and Symbol Pages
+
+Package route data loader:
+
+```ts
+// pages/api/@pkg/+data.ts
+import { withApiPackage } from 'vike-plugin-typedoc/server';
+import type { PageContextServer } from 'vike/types';
+
+export function data(pageContext: PageContextServer) {
+  return withApiPackage(pageContext, pageContext.routeParams.pkg);
+}
+```
+
+Package route component:
+
+```tsx
+// pages/api/@pkg/+Page.tsx
+import { useApiPackage } from 'vike-plugin-typedoc/client';
+
+export default function Page() {
+  const { apiPackage, packageName } = useApiPackage();
+  if (!apiPackage) return <h1>Package not found: {packageName}</h1>;
+  return <h1>{packageName}</h1>;
+}
+```
+
+Symbol route data loader:
+
+```ts
+// pages/api/@pkg/@symbol/+data.ts
+import { withApiExport } from 'vike-plugin-typedoc/server';
+import type { PageContextServer } from 'vike/types';
+
+export function data(pageContext: PageContextServer) {
+  const { pkg, symbol } = pageContext.routeParams;
+  return withApiExport(pageContext, pkg, symbol);
+}
+```
+
+Symbol route component:
+
+```tsx
+// pages/api/@pkg/@symbol/+Page.tsx
+import { useApiExport } from 'vike-plugin-typedoc/client';
+
+export default function Page() {
+  const { apiExport, packageName } = useApiExport();
+  if (!apiExport) return <h1>Symbol not found in {packageName}</h1>;
+  return <h1>{apiExport.name}</h1>;
+}
+```
+
+## `typedoc` Config Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `typedocDir` | `string` | Directory containing `*.json` TypeDoc output files. |
+| `packageNames` | `Record<string, string>` | Optional slug-to-npm-name overrides. |
+| `packagesDir` | `string` | Reads missing package names from `<packagesDir>/<slug>/package.json`. |
+| `exclude` | `string[]` | Package slugs to skip when loading docs. |
+| `buildUrl` | `(packageSlug: string, symbolSlug?: string) => string` | Custom URL builder for package and symbol pages. |
+| `basePath` | `string` | Prefix used by default URL builder. Defaults to `/api`. |
+| `baseUrl` | `string` | Deployment base URL used when generating HTML links. |
+| `remarkPlugins` | `PluggableList` | Extra remark plugins for markdown rendering. |
+| `rehypePlugins` | `PluggableList` | Extra rehype plugins for markdown rendering (for example syntax highlighting). |
+
+## Server and Client Entrypoints
+
+- `vike-plugin-typedoc/server`:
+  - `loadTypedocContext()`
+  - `getTypedocContext()`
+  - `withApiPackage()`
+  - `withApiExport()`
+- `vike-plugin-typedoc/client`:
+  - `useApiPackage()`
+  - `useApiExport()`
+
+## Headless Utilities (Without Vike Hooks)
+
+Root exports are usable even outside Vike page hooks:
+
+```ts
+import {
+  buildApiNavigation,
+  buildMarkdownProcessor,
+  buildSymbolsMap,
+  combineApiDocs,
+  createTypedocContext,
+  parseTypedocJson,
+} from 'vike-plugin-typedoc';
+```
+
+This is useful if you want to parse TypeDoc JSON once and feed another renderer, while reusing the same symbol-linking logic.
+
+## License
+
+MIT

package/README.md.template

@@ -0,0 +1,148 @@
+# vike-plugin-typedoc
+
+Headless TypeDoc integration for Vike documentation sites.
+
+## Installation
+
+```bash
+npm install vike-plugin-typedoc
+```
+
+Peer dependencies:
+
+- `vike >= 0.4.250`
+- `vike-react >= 0.5` (if you use the React hooks)
+- `react >= 18` (if you use the React hooks)
+
+## What It Does
+
+- Loads TypeDoc JSON files into a cached `TypedocContext`.
+- Builds package and symbol URLs (default `/api/:pkg/:symbol`).
+- Builds API navigation trees.
+- Pre-renders markdown fields and auto-links type references.
+- Provides Vike data helpers (`withApiPackage`, `withApiExport`) and React hooks (`useApiPackage`, `useApiExport`).
+- Provides a Vike config extension that auto-loads context and prerender URLs.
+
+## Quick Start
+
+Add the plugin extension and `typedoc` config:
+
+```ts
+import { join } from 'node:path';
+import vikePluginTypedoc from 'vike-plugin-typedoc/config';
+import vikeReact from 'vike-react/config';
+import type { Config } from 'vike/types';
+
+const root = process.cwd();
+
+export default {
+  extends: [vikeReact, vikePluginTypedoc],
+  prerender: true,
+  typedoc: {
+    typedocDir: join(root, '.typedoc'),
+    packagesDir: join(root, 'packages'),
+    basePath: '/api',
+  },
+} satisfies Config;
+```
+
+The plugin expects one TypeDoc JSON file per package slug in `typedocDir` (for example `.typedoc/devkit.json`).
+
+## Package and Symbol Pages
+
+Package route data loader:
+
+```ts
+// pages/api/@pkg/+data.ts
+import { withApiPackage } from 'vike-plugin-typedoc/server';
+import type { PageContextServer } from 'vike/types';
+
+export function data(pageContext: PageContextServer) {
+  return withApiPackage(pageContext, pageContext.routeParams.pkg);
+}
+```
+
+Package route component:
+
+```tsx
+// pages/api/@pkg/+Page.tsx
+import { useApiPackage } from 'vike-plugin-typedoc/client';
+
+export default function Page() {
+  const { apiPackage, packageName } = useApiPackage();
+  if (!apiPackage) return <h1>Package not found: {packageName}</h1>;
+  return <h1>{packageName}</h1>;
+}
+```
+
+Symbol route data loader:
+
+```ts
+// pages/api/@pkg/@symbol/+data.ts
+import { withApiExport } from 'vike-plugin-typedoc/server';
+import type { PageContextServer } from 'vike/types';
+
+export function data(pageContext: PageContextServer) {
+  const { pkg, symbol } = pageContext.routeParams;
+  return withApiExport(pageContext, pkg, symbol);
+}
+```
+
+Symbol route component:
+
+```tsx
+// pages/api/@pkg/@symbol/+Page.tsx
+import { useApiExport } from 'vike-plugin-typedoc/client';
+
+export default function Page() {
+  const { apiExport, packageName } = useApiExport();
+  if (!apiExport) return <h1>Symbol not found in {packageName}</h1>;
+  return <h1>{apiExport.name}</h1>;
+}
+```
+
+## `typedoc` Config Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `typedocDir` | `string` | Directory containing `*.json` TypeDoc output files. |
+| `packageNames` | `Record<string, string>` | Optional slug-to-npm-name overrides. |
+| `packagesDir` | `string` | Reads missing package names from `<packagesDir>/<slug>/package.json`. |
+| `exclude` | `string[]` | Package slugs to skip when loading docs. |
+| `buildUrl` | `(packageSlug: string, symbolSlug?: string) => string` | Custom URL builder for package and symbol pages. |
+| `basePath` | `string` | Prefix used by default URL builder. Defaults to `/api`. |
+| `baseUrl` | `string` | Deployment base URL used when generating HTML links. |
+| `remarkPlugins` | `PluggableList` | Extra remark plugins for markdown rendering. |
+| `rehypePlugins` | `PluggableList` | Extra rehype plugins for markdown rendering (for example syntax highlighting). |
+
+## Server and Client Entrypoints
+
+- `vike-plugin-typedoc/server`:
+  - `loadTypedocContext()`
+  - `getTypedocContext()`
+  - `withApiPackage()`
+  - `withApiExport()`
+- `vike-plugin-typedoc/client`:
+  - `useApiPackage()`
+  - `useApiExport()`
+
+## Headless Utilities (Without Vike Hooks)
+
+Root exports are usable even outside Vike page hooks:
+
+```ts
+import {
+  buildApiNavigation,
+  buildMarkdownProcessor,
+  buildSymbolsMap,
+  combineApiDocs,
+  createTypedocContext,
+  parseTypedocJson,
+} from 'vike-plugin-typedoc';
+```
+
+This is useful if you want to parse TypeDoc JSON once and feed another renderer, while reusing the same symbol-linking logic.
+
+## License
+
+MIT

package/dist/+config.d.ts

@@ -0,0 +1,41 @@
+import type { TypedocContext } from './context.js';
+import type { LoadTypedocContextOptions } from './server.js';
+declare global {
+    namespace Vike {
+        interface Config {
+            /** Configuration for vike-plugin-typedoc. */
+            typedoc?: LoadTypedocContextOptions;
+        }
+        interface GlobalContextServer {
+            $$VIKE_PLUGIN_TYPEDOC$$?: TypedocContext;
+        }
+    }
+}
+declare const _default: {
+    name: string;
+    require: {
+        vike: string;
+    };
+    onCreateGlobalContext: "import:vike-plugin-typedoc/__internal/hooks/onCreateGlobalContext:onCreateGlobalContext";
+    onBeforePrerenderStart: "import:vike-plugin-typedoc/__internal/hooks/onBeforePrerenderStart:onBeforePrerenderStart";
+    meta: {
+        typedoc: {
+            env: {
+                server: true;
+            };
+            global: true;
+        };
+        onCreateGlobalContext: {
+            env: {
+                server: true;
+            };
+        };
+        onBeforePrerenderStart: {
+            env: {
+                server: true;
+            };
+        };
+    };
+};
+export default _default;
+//# sourceMappingURL=+config.d.ts.map

package/dist/+config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"+config.d.ts","sourceRoot":"","sources":["../src/+config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAE7D,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,IAAI,CAAC;QACb,UAAU,MAAM;YACd,6CAA6C;YAC7C,OAAO,CAAC,EAAE,yBAAyB,CAAC;SACrC;QACD,UAAU,mBAAmB;YAC3B,uBAAuB,CAAC,EAAE,cAAc,CAAC;SAC1C;KACF;CACF;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED,wBAqBmB"}

package/dist/+config.js

@@ -0,0 +1,21 @@
+export default {
+    name: 'vike-plugin-typedoc',
+    require: {
+        vike: '>=0.4.250',
+    },
+    onCreateGlobalContext: 'import:vike-plugin-typedoc/__internal/hooks/onCreateGlobalContext:onCreateGlobalContext',
+    onBeforePrerenderStart: 'import:vike-plugin-typedoc/__internal/hooks/onBeforePrerenderStart:onBeforePrerenderStart',
+    meta: {
+        typedoc: {
+            env: { server: true },
+            global: true,
+        },
+        onCreateGlobalContext: {
+            env: { server: true },
+        },
+        onBeforePrerenderStart: {
+            env: { server: true },
+        },
+    },
+};
+//# sourceMappingURL=+config.js.map

package/dist/+config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"+config.js","sourceRoot":"","sources":["../src/+config.ts"],"names":[],"mappings":"AAiBA,eAAe;IACb,IAAI,EAAE,qBAAqB;IAC3B,OAAO,EAAE;QACP,IAAI,EAAE,WAAW;KAClB;IACD,qBAAqB,EACnB,yFAAyF;IAC3F,sBAAsB,EACpB,2FAA2F;IAC7F,IAAI,EAAE;QACJ,OAAO,EAAE;YACP,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;YACrB,MAAM,EAAE,IAAI;SACb;QACD,qBAAqB,EAAE;YACrB,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACtB;QACD,sBAAsB,EAAE;YACtB,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;SACtB;KACF;CACe,CAAC"}

package/dist/client.d.ts

@@ -0,0 +1,14 @@
+import type { ApiExportData, ApiPackageData } from './server.js';
+/**
+ * Read API package data from page data in a `+Page.tsx` component.
+ *
+ * Requires that `+data.ts` returns `withApiPackage()` from the server entry.
+ */
+export declare function useApiPackage(): ApiPackageData;
+/**
+ * Read API export/symbol data from page data in a `+Page.tsx` component.
+ *
+ * Requires that `+data.ts` returns `withApiExport()` from the server entry.
+ */
+export declare function useApiExport(): ApiExportData;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAIjE;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,cAAc,CAS9C;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,aAAa,CAS5C"}

package/dist/client.js

@@ -0,0 +1,29 @@
+import { useData } from 'vike-react/useData';
+const DATA_KEY = '$$VIKE_PLUGIN_TYPEDOC$$';
+/**
+ * Read API package data from page data in a `+Page.tsx` component.
+ *
+ * Requires that `+data.ts` returns `withApiPackage()` from the server entry.
+ */
+export function useApiPackage() {
+    const data = useData();
+    const pluginData = data[DATA_KEY];
+    if (!pluginData) {
+        throw new Error('No API package data found in page data. Ensure your +data.ts returns withApiPackage().');
+    }
+    return pluginData;
+}
+/**
+ * Read API export/symbol data from page data in a `+Page.tsx` component.
+ *
+ * Requires that `+data.ts` returns `withApiExport()` from the server entry.
+ */
+export function useApiExport() {
+    const data = useData();
+    const pluginData = data[DATA_KEY];
+    if (!pluginData) {
+        throw new Error('No API export data found in page data. Ensure your +data.ts returns withApiExport().');
+    }
+    return pluginData;
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAG7C,MAAM,QAAQ,GAAG,yBAAyB,CAAC;AAE3C;;;;GAIG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,IAAI,GAAG,OAAO,EAA2B,CAAC;IAChD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAA+B,CAAC;IAChE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;IACJ,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY;IAC1B,MAAM,IAAI,GAAG,OAAO,EAA2B,CAAC;IAChD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAA8B,CAAC;IAC/D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAC;IACJ,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/context.d.ts

@@ -0,0 +1,83 @@
+import type { RehypeTypedocOptions, SymbolEntry } from 'rehype-typedoc';
+import type { PluggableList } from 'unified';
+import type { LinkedApiExport } from './linkify.js';
+import type { ApiDocs, ApiPackage, NavigationItem } from './types.js';
+export interface TypedocContextOptions {
+    /**
+     * Build a URL for a package or symbol page.
+     * Called for every link the plugin generates.
+     *
+     * @default (pkg, sym) => sym ? `/api/${pkg}/${sym}` : `/api/${pkg}`
+     */
+    buildUrl?: (packageSlug: string, symbolSlug?: string) => string;
+    /**
+     * Base path prefix for generated URLs.
+     * Used to build the default `buildUrl` when no custom function is provided.
+     *
+     * @default '/api'
+     * @example '/docs/api' → URLs like `/docs/api/devkit/parse-json`
+     */
+    basePath?: string;
+    /**
+     * Deployment base URL to prepend to rendered HTML links.
+     *
+     * When set, `buildLink` (used by rehype-typedoc for inline type links and
+     * rendered markdown) prepends this base to every route-relative path.
+     * Stored paths (`exp.path`, `navItem.path`) and prerender URLs are
+     * **not** affected — they remain route-relative.
+     *
+     * Typically read from `globalContext.baseServer` in the Vike hook.
+     *
+     * @default '/'
+     */
+    baseUrl?: string;
+    /**
+     * Additional remark plugins to include in the markdown pipeline.
+     * These run after the baked-in plugins (remark-gfm, remark-code-props)
+     * and before remark-rehype.
+     */
+    remarkPlugins?: PluggableList;
+    /**
+     * Additional rehype plugins to include in the markdown pipeline.
+     * These run after the baked-in rehype-typedoc plugin and before
+     * rehype-stringify. Use this to add syntax highlighting
+     * (e.g., `@shikijs/rehype`).
+     */
+    rehypePlugins?: PluggableList;
+}
+export interface TypedocContext {
+    /** All parsed API documentation */
+    apiDocs: ApiDocs;
+    /** Symbols map (for rehype-typedoc or custom use) */
+    symbolsMap: Map<string, SymbolEntry>;
+    /** Navigation items for sidebar */
+    navigation: NavigationItem[];
+    /** Pre-built options to pass to rehype-typedoc */
+    rehypeOptions: RehypeTypedocOptions;
+    /** The resolved base URL (from options.baseUrl, normalized) */
+    baseUrl: string;
+    /** Prepend the deployment base URL to a route-relative path */
+    applyBaseUrl(path: string): string;
+    /** Get a linked export by package + symbol slug */
+    getLinkedExport(packageSlug: string, symbolSlug: string): LinkedApiExport | null;
+    /** Get package info */
+    getPackage(packageSlug: string): ApiPackage | null;
+    /** Get all export URLs (for pre-rendering) */
+    getExportUrls(): string[];
+    /** Get all package-level URLs (for pre-rendering) */
+    getPackageUrls(): string[];
+    /** Get all prerender URLs (packages + exports) */
+    getAllPrerenderUrls(): string[];
+}
+/**
+ * Create a TypedocContext from pre-parsed packages.
+ *
+ * This is the low-level API — use `loadTypedocContext` for the common case
+ * of loading TypeDoc JSON files from disk.
+ *
+ * The function is async because it eagerly pre-renders all markdown fields
+ * (descriptions, remarks, examples) through a unified pipeline so that
+ * `getLinkedExport()` can return fully-rendered HTML synchronously.
+ */
+export declare function createTypedocContext(packages: ApiPackage[], options?: TypedocContextOptions): Promise<TypedocContext>;
+//# sourceMappingURL=context.d.ts.map

package/dist/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AASpD,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEtE,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAEhE;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B,mCAAmC;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,qDAAqD;IACrD,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACrC,mCAAmC;IACnC,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,kDAAkD;IAClD,aAAa,EAAE,oBAAoB,CAAC;IACpC,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,mDAAmD;IACnD,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI,CAAC;IACjF,uBAAuB;IACvB,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;IACnD,8CAA8C;IAC9C,aAAa,IAAI,MAAM,EAAE,CAAC;IAC1B,qDAAqD;IACrD,cAAc,IAAI,MAAM,EAAE,CAAC;IAC3B,kDAAkD;IAClD,mBAAmB,IAAI,MAAM,EAAE,CAAC;CACjC;AA+BD;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CACxC,QAAQ,EAAE,UAAU,EAAE,EACtB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,cAAc,CAAC,CAqHzB"}

package/dist/context.js

@@ -0,0 +1,129 @@
+import { linkifyApiExport, linkifyType } from './linkify.js';
+import { buildMarkdownProcessor, renderExportMarkdown, } from './markdown.js';
+import { buildApiNavigation } from './navigation.js';
+import { combineApiDocs } from './parser.js';
+import { buildSymbolsMap } from './symbols.js';
+function createDefaultBuildUrl(basePath) {
+    return (packageSlug, symbolSlug) => symbolSlug ? `${basePath}/${packageSlug}/${symbolSlug}` : `${basePath}/${packageSlug}`;
+}
+/**
+ * Build an `applyBaseUrl` function from a raw base URL string.
+ *
+ * Returns the identity function when the base is falsy, `/`, `./`, or `.`
+ * (i.e., no deployment prefix). Otherwise normalizes and prepends the base.
+ */
+function createApplyBaseUrl(raw) {
+    if (!raw || raw === '/' || raw === './' || raw === '.') {
+        return (path) => path;
+    }
+    const normalizedBase = raw.endsWith('/') ? raw : raw + '/';
+    return (path) => {
+        const normalizedPath = path.startsWith('/') ? path.substring(1) : path;
+        return normalizedBase + normalizedPath;
+    };
+}
+/**
+ * Build a cache key for a rendered export: `packageSlug::symbolSlug`
+ */
+function markdownCacheKey(packageSlug, symbolSlug) {
+    return `${packageSlug}::${symbolSlug}`;
+}
+/**
+ * Create a TypedocContext from pre-parsed packages.
+ *
+ * This is the low-level API — use `loadTypedocContext` for the common case
+ * of loading TypeDoc JSON files from disk.
+ *
+ * The function is async because it eagerly pre-renders all markdown fields
+ * (descriptions, remarks, examples) through a unified pipeline so that
+ * `getLinkedExport()` can return fully-rendered HTML synchronously.
+ */
+export async function createTypedocContext(packages, options = {}) {
+    const buildUrl = options.buildUrl ?? createDefaultBuildUrl(options.basePath ?? '/api');
+    const applyBaseUrl = createApplyBaseUrl(options.baseUrl);
+    const baseUrl = options.baseUrl ?? '/';
+    // Apply buildUrl to every export path
+    for (const pkg of packages) {
+        for (const exp of pkg.exports) {
+            exp.path = buildUrl(pkg.slug, exp.slug);
+        }
+        for (const mod of pkg.modules) {
+            for (const exp of mod.exports) {
+                exp.path = buildUrl(pkg.slug, exp.slug);
+            }
+        }
+    }
+    const apiDocs = combineApiDocs(packages);
+    const symbolsMap = buildSymbolsMap(apiDocs);
+    const navigation = buildApiNavigation(apiDocs);
+    // Update navigation paths using buildUrl
+    for (const navItem of navigation) {
+        const pkg = Object.values(apiDocs.packages).find((p) => p.name === navItem.title);
+        if (pkg) {
+            navItem.path = buildUrl(pkg.slug);
+        }
+    }
+    const buildLink = (symbol) => symbol.path ? applyBaseUrl(symbol.path) : undefined;
+    const rehypeOptions = {
+        symbols: symbolsMap,
+        buildLink,
+    };
+    // Build the markdown processor and pre-render all exports
+    const processor = buildMarkdownProcessor(rehypeOptions, options.remarkPlugins, options.rehypePlugins);
+    const renderedMarkdown = new Map();
+    await Promise.all(apiDocs.allExports.map(async (exp) => {
+        const rendered = await renderExportMarkdown(processor, exp.comment, exp.description, exp.signature, exp.returnType);
+        renderedMarkdown.set(markdownCacheKey(exp.package, exp.slug), rendered);
+    }));
+    return {
+        apiDocs,
+        symbolsMap,
+        navigation,
+        rehypeOptions,
+        baseUrl,
+        applyBaseUrl,
+        getLinkedExport(packageSlug, symbolSlug) {
+            const apiPackage = apiDocs.packages[packageSlug];
+            if (!apiPackage)
+                return null;
+            const rawExport = apiPackage.exports.find((e) => e.slug === symbolSlug);
+            if (!rawExport)
+                return null;
+            const linked = linkifyApiExport(rawExport, (typeStr) => linkifyType(typeStr, symbolsMap, buildLink));
+            // Merge pre-rendered markdown HTML (code block linkification is now
+            // handled by rehypeTypedocCodeBlocks in the unified pipeline)
+            const md = renderedMarkdown.get(markdownCacheKey(packageSlug, symbolSlug));
+            if (md) {
+                if (md.signatureCodeHtml)
+                    linked.signatureCodeHtml = md.signatureCodeHtml;
+                if (md.returnTypeCodeHtml)
+                    linked.returnTypeCodeHtml = md.returnTypeCodeHtml;
+                if (md.descriptionHtml)
+                    linked.descriptionHtml = md.descriptionHtml;
+                if (md.remarksHtml)
+                    linked.remarksHtml = md.remarksHtml;
+                if (md.examplesHtml)
+                    linked.examplesHtml = md.examplesHtml;
+            }
+            return linked;
+        },
+        getPackage(packageSlug) {
+            return apiDocs.packages[packageSlug] ?? null;
+        },
+        getExportUrls() {
+            return apiDocs.allExports.map((exp) => exp.path);
+        },
+        getPackageUrls() {
+            return Object.values(apiDocs.packages).map((pkg) => buildUrl(pkg.slug));
+        },
+        getAllPrerenderUrls() {
+            return [
+                ...new Set([
+                    ...Object.values(apiDocs.packages).map((pkg) => buildUrl(pkg.slug)),
+                    ...apiDocs.allExports.map((exp) => exp.path),
+                ]),
+            ];
+        },
+    };
+}
+//# sourceMappingURL=context.js.map

package/dist/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EACL,sBAAsB,EACtB,oBAAoB,GAErB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AA4E/C,SAAS,qBAAqB,CAAC,QAAgB;IAC7C,OAAO,CAAC,WAAmB,EAAE,UAAmB,EAAU,EAAE,CAC1D,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,WAAW,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,WAAW,EAAE,CAAC;AAC3F,CAAC;AAED;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,GAAuB;IACjD,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;QACvD,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;IACxB,CAAC;IACD,MAAM,cAAc,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IAC3D,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACvE,OAAO,cAAc,GAAG,cAAc,CAAC;IACzC,CAAC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB,CAAC,WAAmB,EAAE,UAAkB;IAC/D,OAAO,GAAG,WAAW,KAAK,UAAU,EAAE,CAAC;AACzC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,QAAsB,EACtB,UAAiC,EAAE;IAEnC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,qBAAqB,CAAC,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC;IACvF,MAAM,YAAY,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,GAAG,CAAC;IAEvC,sCAAsC;IACtC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAC9B,GAAG,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAC9B,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;gBAC9B,GAAG,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,UAAU,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAE/C,yCAAyC;IACzC,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,KAAK,CAChC,CAAC;QACF,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,CAAC,MAAyB,EAAE,EAAE,CAC9C,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEtD,MAAM,aAAa,GAAyB;QAC1C,OAAO,EAAE,UAAU;QACnB,SAAS;KACV,CAAC;IAEF,0DAA0D;IAC1D,MAAM,SAAS,GAAG,sBAAsB,CACtC,aAAa,EACb,OAAO,CAAC,aAAa,EACrB,OAAO,CAAC,aAAa,CACtB,CAAC;IAEF,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAkC,CAAC;IACnE,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACnC,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CACzC,SAAS,EACT,GAAG,CAAC,OAAO,EACX,GAAG,CAAC,WAAW,EACf,GAAG,CAAC,SAAS,EACb,GAAG,CAAC,UAAU,CACf,CAAC;QACF,gBAAgB,CAAC,GAAG,CAClB,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,EACvC,QAAQ,CACT,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IAEF,OAAO;QACL,OAAO;QACP,UAAU;QACV,UAAU;QACV,aAAa;QACb,OAAO;QACP,YAAY;QAEZ,eAAe,CAAC,WAAmB,EAAE,UAAkB;YACrD,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;YACjD,IAAI,CAAC,UAAU;gBAAE,OAAO,IAAI,CAAC;YAE7B,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;YACxE,IAAI,CAAC,SAAS;gBAAE,OAAO,IAAI,CAAC;YAE5B,MAAM,MAAM,GAAG,gBAAgB,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CACrD,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,CAAC,CAC5C,CAAC;YAEF,oEAAoE;YACpE,8DAA8D;YAC9D,MAAM,EAAE,GAAG,gBAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;YAC3E,IAAI,EAAE,EAAE,CAAC;gBACP,IAAI,EAAE,CAAC,iBAAiB;oBAAE,MAAM,CAAC,iBAAiB,GAAG,EAAE,CAAC,iBAAiB,CAAC;gBAC1E,IAAI,EAAE,CAAC,kBAAkB;oBAAE,MAAM,CAAC,kBAAkB,GAAG,EAAE,CAAC,kBAAkB,CAAC;gBAC7E,IAAI,EAAE,CAAC,eAAe;oBAAE,MAAM,CAAC,eAAe,GAAG,EAAE,CAAC,eAAe,CAAC;gBACpE,IAAI,EAAE,CAAC,WAAW;oBAAE,MAAM,CAAC,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC;gBACxD,IAAI,EAAE,CAAC,YAAY;oBAAE,MAAM,CAAC,YAAY,GAAG,EAAE,CAAC,YAAY,CAAC;YAC7D,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,UAAU,CAAC,WAAmB;YAC5B,OAAO,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC;QAC/C,CAAC;QAED,aAAa;YACX,OAAO,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;QAED,cAAc;YACZ,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,CAAC;QAED,mBAAmB;YACjB,OAAO;gBACL,GAAG,IAAI,GAAG,CAAC;oBACT,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBACnE,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;iBAC7C,CAAC;aACH,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/hooks/onBeforePrerenderStart.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Vike extension hook — called automatically during pre-rendering to
+ * generate the list of API URLs that need static HTML.
+ *
+ * Reads the TypedocContext previously stored on the global context by
+ * the `onCreateGlobalContext` hook and returns all package + export URLs.
+ */
+export declare function onBeforePrerenderStart(): Promise<string[]>;
+//# sourceMappingURL=onBeforePrerenderStart.d.ts.map

package/dist/hooks/onBeforePrerenderStart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onBeforePrerenderStart.d.ts","sourceRoot":"","sources":["../../src/hooks/onBeforePrerenderStart.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAaH,wBAAsB,sBAAsB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAqBhE"}