design.md
A format specification for describing a visual identity to coding agents. DESIGN.md gives agents a persistent, structured understanding of a design system.
Integrate the DESIGN.md linter programmatically with its TypeScript API. Validate design tokens, get lint findings, and generate Tailwind config synchronously. Learn how now.
Export Formats for DESIGN.md Tokens: CSS, Tailwind v4, and DTCG OutputDiscover DESIGN.md token export formats like CSS, Tailwind v4, and DTCG. Transform your design tokens into usable CSS variables, Tailwind v3 JSON, or W3C standard JSON.
What Is the Export Command in DESIGN.md? A Complete Guide to Token ConversionMaster the export command in DESIGN.md to convert design tokens into production-ready formats like Tailwind CSS W3C Design Tokens and CSS custom properties Streamline your workflow today
How to Use the design.md diff Command in CI/CD PipelinesLearn how to use the design.md diff command in CI/CD to automatically block pull requests with design regressions. Detect errors and warnings before they merge.
How to Compare Two DESIGN.md Files to Detect Changes and RegressionsEasily compare two DESIGN.md files using the design-system CLI diff command. Detect changes and regressions with a structural diff and get an exit code of 1 for errors.
What Validation Rules Does the `lint` Command Enforce in Design.md?Discover the 11 validation rules enforced by the Design.md lint command. Ensure structural integrity, token completeness, accessibility, and schema conformance for your DESIGN.md files.
How the design.md Lint Command Reports Validation Results and Exit CodesLearn how the design.md lint command reports validation results. Understand exit codes 0, 1, 2 and get detailed findings for successful runs or errors.
How to Validate a DESIGN.md File Using the CLI: The Complete GuideEasily validate your DESIGN.md files with the CLI using the design.md lint command. Get instant feedback on structure and rules for better documentation.
What Are the Four Main Subcommands of the DESIGN.md CLI?Explore the four main subcommands of the DESIGN.md CLI: spec, lint, export, and diff. Learn how to display specifications, validate structure, generate artifacts, and compare versions.
What Framework Powers the DESIGN.md CLI? Inside the Citty ArchitectureDiscover the Citty architecture powering the DESIGN.md CLI. Explore this type-safe, lightweight framework for defining commands and sub-commands in this in-depth technical analysis.
What Happens When a Token Reference in DESIGN.md Is Broken?Learn what happens when a token reference in DESIGN.md is broken. Discover how the linter handles unresolved references and preserves your design system state.
How to Reference Tokens Within DESIGN.md: Syntax and ExamplesLearn the syntax for referencing tokens in DESIGN.md using curly braces {section.tokenName}. Easily pull values from YAML front-matter into your design prose and component definitions.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" 
Maintain an open-source project? Get it listed too →