Skip to content

@docsxai/plugin-starlight

docsxai renderer plugin for Astro Starlight. Registers starlight:site, a thin adapter over the viewer's emitStarlightSite / buildStarlightSite: it turns a doc pack into a complete, buildable Starlight project: one MDX page per flow, burned screenshots preferred (clean fallback), sidebar ordered by the flow extends graph, theme accents derived from the style artifact's visual keys.

No egress: the manifest declares zero capabilities. Emission is deterministic and the emitted site is self-contained (no remote fonts, no CDN imports); astro + @astrojs/starlight versions are exact-pinned into the emitted package.json.

Repo-only. @docsxai/plugin-starlight is not published to npm (private: true). Build it from a checkout (pnpm -r build) and wire it by path: { "path": "<checkout>/packages/plugin-starlight" } (relative paths resolve from the workspace directory). The { "package": ... } form below only resolves once the plugin is installed in the workspace's node_modules.

.docsxai.json:

{
"plugins": [{ "package": "@docsxai/plugin-starlight" }]
}

Passed as the renderer's config:

KeyRequiredMeaning
titlenoSite title. Default "Documentation".
accentnoAccent hex color (#rrggbb); overrides the style artifact's visual accent keys.
logonoLogo path (absolute, or relative to the workspace); overrides visual.logo.
langnoSite language, a locale tag: es, es-ES and es_MX give Spanish, any other tag English (default).
buildnotrue also runs astro build (writes <outDir>/dist); default emit-only.

The context's flows filter restricts the site to those flows; empty means all flows under docs/.

All emission behavior (MDX shape, accent scale, image preference, determinism, the no-network posture) is documented and tested in @docsxai/viewer.

Apache-2.0.

Made by KalebtecGitHubApache-2.0 licensed