| basePath? | string | Base path prefix for generated URLs.
Used to build the default `buildUrl` when no custom function is provided. |
| baseUrl? | string | Deployment base URL to prepend to rendered HTML links.
When set, `applyBaseUrl` 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. |
| buildUrl? | (packageSlug: string, symbolSlug?: string) => string | Build a URL for a package or symbol page.
Called for every link the plugin generates. |
| documents? | TypeDocDocument[] | Raw TypeDoc JSON documents for rehype-typedoc auto-linking |
| rehypePlugins? | 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`). |
| remarkPlugins? | PluggableList | 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. |
| theme? | BundledTheme | Shiki theme for signature syntax highlighting |
