design-md

Scan codebases to generate DESIGN.md files with YAML tokens and Markdown sections.

Updated Jun 28, 2026
One-click install
npx skills add https://github.com/Zircoz/design.md-skill --skill design-md-zircoz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-md
Source: https://github.com/Zircoz/design.md-skill/tree/main
Command: npx skills add https://github.com/Zircoz/design.md-skill --skill design-md-zircoz

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires tailwindcss, design-md-cli, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill simplifies the creation and maintenance of a comprehensive design system document, saving time and ensuring consistency across projects.

Core Features & Use Cases

  • Automated Design System Generation: Generate or update a DESIGN.md file by scanning a codebase for design signals.
  • YAML and Markdown Output: Outputs machine-readable design tokens and human-readable sections in Markdown format.
  • Tailwind and Lint Compliance: Ensures the generated document complies with the Tailwind CSS and design.md specification.

Quick Start

Run the command /design-md from the root of your project directory to create or update your DESIGN.md file.

Frequently Asked Questions about design-md

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

FAQPage Schema
How do I automate design system documentation for my codebase?

You can automate design system documentation by running a command that scans your codebase for design signals like colors and typography, then generates a DESIGN.md file with YAML tokens and Markdown sections.

Can I generate a design system document from Tailwind CSS tokens?

Yes, you can generate a design system document from Tailwind CSS tokens. The tool scans your project to produce a DESIGN.md file that complies with the Tailwind CSS and design.md specification.

What is the best way to extract design tokens into Markdown documentation?

The best way to extract design tokens into Markdown documentation is using an automated scanner that analyzes your codebase and outputs both machine-readable YAML tokens and human-readable Markdown sections.

Do I need Tailwind CSS to generate a DESIGN.md file?

You need Tailwind CSS and the design-md-cli dependency to ensure the generated DESIGN.md file complies with the required specification. Run the command from your project's root directory to create or update the file.

How does codebase analysis for design signals work?

Codebase analysis for design signals works by scanning your project files to identify colors, typography, and spacing patterns. It then compiles these signals into a structured design system document.

What are the limitations of automated design system generation?

Automated design system generation is limited by its dependencies on Tailwind CSS and the design.md specification. It extracts existing design signals from the codebase but requires proper project setup to ensure accurate scanning and compliance.