Reference
Public API
The exports, binaries and styles of @doqs/analog, with their intended stability.
Everything listed here is exported by the published package and covered by the automated public-API check, which compares the packed package's declarations with a committed report. "Stable intent" is the 1.0 plan; pre-1.0 releases may still adjust it, announced in the changelog.
Configuration and routing
| Export | Kind | Intent |
|---|---|---|
defineDoqConfig(config) |
function | Stable |
provideDoq(config) |
function | Stable |
doqRoutes(config) |
function | Stable |
doqPrerenderRoutes(paths) |
function | Stable |
DoqConfig, DoqPaths, DoqSlots, DoqPresentation, DoqDemoRegistry |
types | Stable |
DoqSearchConfig, DoqSearchResult |
types | Stable |
DoqVersioning, DoqVersionConfig, DoqArchiveConfig |
types | Stable |
Components
| Export | Intent |
|---|---|
DoqDocsComponent, DoqIndexComponent |
Used through doqRoutes(); the class names are public, the selectors are not a contract |
DoqShellComponent |
Stable, optional |
DoqTabsComponent, DoqVersionSwitcherComponent |
Internal building blocks that are exported; not recommended for direct use |
Helpers
Exported for tooling and tests, with weaker guarantees: normalizeDoqPaths, doqPrerenderRoute, joinDoqPath, splitDoqInlineDemos, DOQ_INLINE_DEMO_PATTERN, parseDoqContent, DOQ_CALLOUT_TYPES, normalizeDoqSearchConfig, normalizeSearchResultUrl, doqVersionLinks, DOQ_VERSION_FILTER and the document helpers.
Node-only entry points
Never import these in browser code.
| Import | Exports |
|---|---|
@doqs/analog/vite |
doqDeterministicMarkdown(options?) |
@doqs/analog/search-index |
indexDoqSearch |
@doqs/analog/api-reference |
generateApiReference, checkApiReference, buildApiReference, DoqApiError |
Binaries and styles
doq (init, doctor), doq-search (index), doq-api (generate, check), and @doqs/analog/styles.css.
Source
The source, with type declarations next to it, is in packages/doq of the repository, and the package is on npm.