Documentation build pipeline

The build combines component metadata, authored guides, and site templates. Eleventy renders the pages with Vento templates. The @taprootio/wtfm plugin provides component reference pages and interactive examples.

Component metadata

The Custom Elements Manifest analyzer reads component source, decorators, and JSDoc comments. It writes custom-elements.json, which describes properties, attributes, events, slots, parts, and CSS custom properties.

npm run build-cem

API metadata comes from the manifest; introductions and examples come from class comments. See component authoring.

Static pages

Eleventy reads source under docs/, including guides in docs/guides/, and writes the site to public/. The build also creates JavaScript bundles, TypeScript declarations, manifests, and the search index.

npm run build

For local authoring, use:

npm run dev

Pages under public/ are generated. Edit their source comments, guides, or templates and rebuild.

Interactive examples

The docs renderer turns supported fenced examples into previews alongside their source. Examples can include HTML and scripts that interact with the mounted components. Follow example authoring and copy the conventions from an existing component.

A preview lets readers try an API. Automated tests still cover behavior that an example does not exercise; see documentation and verification.

Local deployment

The Tilt deployment at https://espalier.test/ requires an explicit rebuild. From the repository root, run this before checking source changes on that site:

../taproot/devenv/tilt-rebuild.sh espalier-build taproot-espalier

Tilt intentionally does not watch and rebuild this resource automatically. The repository's contributor guidance covers setup and deployment details.