ApiDocSettings
The settings the API documentation generator reads while it renders pages and links.
Import:
import type { ApiDocSettings } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-settings';Signature:
export interface ApiDocSettingsProperties
| Property | Type | Description |
|---|---|---|
| basePath | string | The site's base path, with a leading slash and no trailing one, e.g. /typescript-lib. Every in-content link the generator emits starts with it. |
| externalTypeLinks | ReadonlyMap<string, string> | Type names mapped to the URL their references link to, for types neither this package nor a packageSites package declares, e.g. an ecosystem's own API reference. Consulted before the generic TypeScript, JavaScript and Web API links, so an entry here wins over them. |
| outputDirectory | string | The folder the generated API pages are written to, normally <docs>/src/content/docs/api. |
| packageName | string | The documented package's name, e.g. @mnaoumov/typescript-lib. Import statements are built from it. |
| packageSites | ReadonlyMap<string, string> | Package names mapped to the root URL of their documentation site, with a trailing slash. A type whose declaration resolves into one of these packages links to its page on that site. |
| sidebarFile | string | The JSON file the generated Starlight sidebar is written to. |
Links to this page: