design-md

Write a Markdown file with YAML frontmatter containing version, name, colors, typography, rounded, spacing, and components tokens, followed by canonical prose sections like Overview and Colors. Quote hex colors and negative dimensions so YAML parses them correctly.

Run npx -y @google/design.md lint DESIGN.md to check component textColor against backgroundColor for WCAG AA 4.5:1 contrast. The linter also reports broken token references, missing primary colors, and section order issues.

Yes, the CLI exports to Tailwind v3 theme JSON with --format json-tailwind, a Tailwind v4 CSS @theme block with --format css-tailwind, and W3C DTCG JSON with --format dtcg. Run lint separately since export succeeds regardless of lint findings.

Token references must use full dotted paths like {colors.primary}; shorthand like {primary} does not resolve. The broken-ref error means the referenced path does not exist in your token definitions.

Define variants as separate sibling component entries such as button-primary-hover, never as nested keys like button-primary.hover. Component properties are limited to a whitelist including backgroundColor, textColor, typography, rounded, and padding.

On Windows the design.md bin name can collide with the .md file association, causing silent no-ops. Use the dot-free alias instead: npx -y -p @google/design.md designmd lint DESIGN.md.