docs-site/api-doc-package-sites
Cross-site links: a type declared in another documented package links to its page on that package’s site.
A type is recognized by where its declaration lives, not by its name: a declaration under node_modules/<package>/dist/lib/{esm,cjs}/<path>.d.{mts,cts} of a package in ApiDocSettings.packageSites is the page <site>api/<path>/<Type>/, built with the generator’s own slug rules, because that site was generated from the same tree. A module that generator skips (@types, index, *-setup, …) has no page, so a type declared there is not linked.
Functions
Section titled “Functions”| Function | Description |
|---|---|
| clearPackageDeclarations | Forgets every declaration registerPackageDeclaration recorded. |
| getPackageTypeUrl | Gets the page URL of a type declared in another documented package. |
| registerPackageDeclaration | Records where a type is declared, so its references link to its page on that package’s site. A declaration outside every ApiDocSettings.packageSites package is ignored. A name two packages declare is remembered as ambiguous and never linked. |
Variables
Section titled “Variables”| Variable | Description |
|---|---|
| DEFAULT_PACKAGE_SITES | The documentation sites of the @mnaoumov packages, which each site links to unless told otherwise. |