Content tooling API

19 public symbols generated from the TypeScript declarations of the library.

Functions

Name	Summary
buildContent	Resolves the pages in memory.
checkContent	Compares the resolved pages with the output directories; never writes.
doqContent	A Vite plugin that resolves the content on build start and re-resolves it, using Vite's watcher, when an authored page, fragment, source file or API index chan…
formatDiagnostic	Formats a diagnostic as the multi-line text the CLI prints.
generateContent	Writes the resolved pages, touching only files it owns.
loadContentConfig	Reads and validates the configuration without touching any content.

Classes

Name	Summary
DoqContentError	A failure with a user-facing message.

Interfaces

Name	Summary
BuildContentResult	Result of buildContent: the resolved pages in memory and every problem found.
CheckContentResult	Result of checkContent.
CheckContentTargetResult	What checkContent found for one target; upToDate is true only when nothing would change.
DoqContentDiagnostic	One problem located in the page (or fragment) the author wrote.
DoqContentOptions	Where to run and what to resolve: a project directory plus a configuration file or inline targets.
DoqContentTarget	One documentation version: its authored pages, where the resolved Markdown goes and what it may read.
DoqContentTargetResult	What generateContent did for one target.
DoqContentVitePlugin	Minimal structural type of the Vite plugin, so the package needs no dependency on Vite.
GenerateContentResult	Result of generateContent.

Types

Name	Summary
DoqContentErrorKind	What went wrong; selects the exit code and the wording of a report.

Constants

Name	Summary
CONFIG_FILE	Default name of the configuration file, read from the project root.
EXIT_CODES	Process exit codes of doq content: stale output 1, configuration 2, output conflict 3, invalid authoring 4.