Documentation

How to install and use the components published from this registry.

How a change gets into this registry, from idea to published package.

The naming, props, styling and testing rules every component in this registry follows.

Create or clone, prerequisites, your first component, and a tour of the repo.

The anatomy of a component folder, scaffolding, README and example conventions, status and tags.

Where generators live, how to run them, and how to write your own in a minute.

Packages that are functions rather than components — how they are generated, documented and shown.

What every component builds, lints, type-checks and tests with, and how to change or override it.

The one-scope rule, registry.config.json, scope.json, and several scopes in one repo.

The Changesets flow, npmjs and GitHub Packages, and the Changelog tab.

The optional design-tokens page and how a theme reaches every component.

Point a component at its design — a Figma frame or any URL — and show it on a Design tab.

Unit tests, Playwright against the static build, and the shipped CI workflow.

Vercel, Netlify, Cloudflare Pages, any static host, or the Docker image.

What npx create-bht-component-registry update touches, what it never touches, and how guide pages are kept current.

Adding the registry to a monorepo you already have.

Why no database, why a static export, and why git and npm rather than a vendor.

What the expanded version adds on top of this registry, and how to get it.

The licence the template, the tool and this site are provided under, and what it means here.