bcd-embed

Embeddable browser compatibility tables backed by live @mdn/browser-compat-data.

The project is currently establishing its v1 contract and implementation foundation. The design and sequencing decisions live in docs/planning.

Repository layout

The planned monorepo keeps the contract, normalization pipeline, static artifact generator, edge adapter, and web component versioned together. The first implemented workspaces are:

• packages/schema — @bcd-embed/schema, the future canonical Zod schemas, inferred TypeScript types, and derived JSON Schema.
• apps/docs — the documentation, examples, and playground application.

The core, generator, server, and element packages will be added when their implementation phases begin.

Development

Requirements:

• Node.js 22.18 or newer
• pnpm 11.13.0, managed through Corepack

Install dependencies and run the complete repository check:

corepack enable
pnpm install
pnpm check

Useful commands:

pnpm dev          # Run the documentation app
pnpm format       # Format the repository
pnpm lint         # Run JavaScript/TypeScript and CSS linting
pnpm typecheck    # Type-check every implemented workspace
pnpm test         # Run the test suite
pnpm build        # Build every implemented workspace

Tooling

Calavera owns the shared formatting, linting, and TypeScript policy. Its repeatable recipe is stored in calavera.config.json. Preview a tooling update before applying it:

pnpm dlx create-project-calavera apply --dry-run
pnpm dlx create-project-calavera apply

Package and application builds use Vite; tests use Vitest.

License

MIT