design.md
View on GitHubA format specification for describing a visual identity to coding agents. DESIGN.md gives agents a persistent, structured understanding of a design system.
DESIGN.md is a spec plus CLI that describes a visual identity as YAML design tokens with markdown rationale, so coding agents build UI that matches a brand. Commands lint (contrast, broken refs), diff versions, export to Tailwind/DTCG, and print the spec for agent prompts.
Use Cases
Feed coding agents a persistent, structured design systemLint DESIGN.md files for broken token refs and structural errorsCheck WCAG AA contrast ratios for component color pairsDiff two design system versions to catch token and prose regressionsExport tokens to Tailwind v3/v4 or W3C DTCG formatsInject the spec into agent prompts so generated UI matches the brandDetect typo'd or dropped YAML keys that would silently break themingGenerate consistent UI components from token references like {colors.tertiary}
Built With
- Language
- TypeScript
- Frameworks
- Bun · Turborepo · TypeScript · Tailwind CSS · W3C Design Tokens (DTCG)
Tags
design-tokens · design-system · coding-agents · agent-context · spec · cli · lint · wcag-contrast · tailwind · dtcg · yaml-frontmatter · ui-generation · typescript · google-labs