design-md

Author, validate, and export Google DESIGN.md design token specification files.

Updated May 29, 2026
One-click install
npx skills add https://github.com/m4an5you6/aspera-agent --skill design-md-m4an5you6
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: design-md
Source: https://github.com/m4an5you6/aspera-agent/tree/main/skills/creative/design-md
Command: npx skills add https://github.com/m4an5you6/aspera-agent --skill design-md-m4an5you6

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @google/design.md.

What problem does it solve? Maintaining a consistent visual identity across projects and coding agents is hard when design decisions live in scattered style guides. This Skill produces a single DESIGN.md file following Google's open spec, combining machine-readable YAML design tokens with human-readable rationale, and validates it for structural errors and WCAG contrast issues. ## Core Features & Use Cases - Authoring: Generate a complete DESIGN.md with colors, typography, spacing, rounded corners, and component tokens using token references like {colors.primary}. - Linting and Diffing: Run the @google/design.md CLI via npx to catch broken token references, duplicate sections, invalid values, and WCAG AA/AAA contrast failures, and diff versions for regressions. - Exporting: Convert the spec to Tailwind theme JSON or W3C DTCG design tokens JSON for direct use in existing projects. - Use Case: A team wants every AI coding agent to apply the same brand. You create a DESIGN.md in the project root, lint it to confirm contrast compliance, and export tailwind.theme.json so the design system is enforced everywhere. ## Quick Start Create a DESIGN.md design token spec for my brand with a blue accent color and Inter typography, then lint it for WCAG contrast issues.

Frequently Asked Questions about design-md

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a DESIGN.md design token file?▼

Write a Markdown file with YAML front matter containing colors, typography, rounded, spacing, and components tokens, followed by canonical prose sections like Overview and Colors. Always include name and colors, and use token references such as {colors.primary} in component definitions.

How to validate design tokens for WCAG contrast?▼

Run npx -y @google/design.md lint DESIGN.md to check component textColor against backgroundColor ratios for WCAG AA (4.5:1) and AAA (7:1). The lint command also catches broken token references, duplicate sections, and invalid color or dimension values.

Can I export DESIGN.md to Tailwind or DTCG format?▼

Yes, the CLI supports both exports. Use npx @google/design.md export --format tailwind for a Tailwind theme JSON, or --format dtcg for W3C Design Tokens Format Module JSON. All commands also accept stdin via the dash argument.

Why does my DESIGN.md fail linting with YAML errors?▼

Hex colors must be quoted strings because YAML interprets the # character as a comment, and negative dimensions like -0.02em must also be quoted. Component variants must be sibling keys like button-primary-hover, never nested under the base component.

When should I use DESIGN.md instead of a regular style guide?▼

Use DESIGN.md when coding agents or multiple projects need machine-readable normative token values alongside human rationale. For purely visual inspiration or one-off HTML prototypes, a formal spec file is unnecessary and lighter design guidance fits better.