API reference
Docs site API
The static documentation site generator (this site).
12 modules, 62 documented exports. Version next. All packages.
packages/docs-site/lib
- apiDocsAPI reference generator: TypeDoc (Apache-2.0) + typedoc-plugin-markdown (MIT) over our real sources, one TypeDoc run per package, markdown out. Exports: API_PACKAGES, collectEntryPoints, exportsOf, generateApiMarkdown, groupOf, headerSummary, withPropsTable
- cliCommandsCLI command reference: every command in the real command registry — `packages/core/command- registry.mjs`, populated by `packages/core/builtin-commands.mjs` exactly the way `packages/cli/ construct.mjs` populates it f... Exports: ALIASES, collectCliCommands, dispatchedCommandNames, renderCliCommandsMarkdown
- markdownMarkdown -> HTML for the documentation pages. Exports: expandIncludes, extractSection, relevel, renderMarkdown, stripTicketRefs, stripTicketRefsHtml, esc
- pagesPage templates: pure functions from data to HTML strings. Exports: docBody, homeBody, layout, notFoundBody, redirectPage, rootFor, searchBody, sectionBody
- sanitizeSanitizer for the HTML the docs site renders from markdown (and for HTML that comes back from GitHub's markdown renderer). Exports: sanitizeHtml
- serverRoutesREST reference for the Cockpit server, read from the real Express route table rather than hand-copied prose: `ui/server/src/index.mjs`'s own `app.<method>(...)` calls, plus every `app.use('/mount', createXRouter(...))... Exports: collectServerRoutes, renderRouteGroupMarkdown
- structureThe documentation site's table of contents: which pages exist, their titles, and where their content comes from. Exports: DEV_GROUPS, DEV_INDEX, EXAMPLE_SURFACES, EXAMPLES_INDEX, HOW_TO_INDEX, USER_GROUPS, USER_INDEX, examplePages, ...
- textSmall pure text helpers shared by the site build: slugs, escaping, title cleanup. Exports: esc, makeSlugger, slugify
- versionsDocumentation versions: which releases exist, where each is served, and the switcher/banner markup. Exports: currentVersion, normalizeBase, planBuilds, releaseVersions, versionBanner, versionSwitcher
- visionStatusThe Vision page: pure functions from a status snapshot (site/data/vision-status.json) to HTML strings. Exports: SNAPSHOT_SCHEMA_VERSION, VISION_PATH, duration, noSnapshotHtml, parseSnapshot, renderVisionStatus