@ambient-ui/docs
v0.1.13
Published
The system's account of itself — the component catalog, the governing documents, and the built registry index, shipped as a versioned package so the site (or any consumer) renders the release it depends on.
Maintainers
Readme
@ambient-ui/docs
The ambientui system's account of itself, as a versioned package.
Two things ship here:
- The component catalog (
@ambient-ui/docs/catalog): what every documented component is, in serializable prose. Summary, behaviour, when to use, when not to. No React, no imports; a Node script can read it as easily as a page can render it. - Content snapshots (
@ambient-ui/docs/content/*): the governing documents (DESIGN.md, the specs, the Figma contract) and the registry index, copied from the repository at build time, so a consumer renders the release it depends on rather than whatever the repo's HEAD says.
This is how the ambientui website stays honest across repositories: it imports this package, and its build fails if its demos fall out of step with the catalog a new release ships.
npm i @ambient-ui/docsimport { AMBIENT_COMPONENTS, SHADCN_DEFAULT_COMPONENTS } from "@ambient-ui/docs"You probably only need this package if you are building tooling or documentation around ambientui. The human-readable reference is at ambientui.ai/ds.
MIT (c) Lumenridge
