docs-site/docs-links
Validates the links emitted by a built documentation site.
Internal links are resolved offline against the build output; external links are validated over the network, deduplicated so each unique URL is fetched at most once. See ./link-check.ts for the decision logic.
It also fails on a GitHub alert that reached a page as a plain blockquote (see ./unrendered-alerts.ts), since nothing else notices when the conversion stops.
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| AssertDocsLinksResolveParams | Options for assertDocsLinksResolve. |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| assertDocsLinksResolve | Checks every link of the built site, and that every GitHub alert rendered as an aside. |