design-system-documenter

Extract design tokens from styling configurations to generate a standardized DESIGN.md file.

Updated Mar 5, 2026
One-click install
npx skills add https://github.com/zivtech/joyus-desktop --skill design-system-documenter-zivtech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-system-documenter
Source: https://github.com/zivtech/joyus-desktop/tree/main/.claude/skills/design-system-documenter
Command: npx skills add https://github.com/zivtech/joyus-desktop --skill design-system-documenter-zivtech

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill solves the problem of fragmented design tokens scattered across various configuration files, CSS, and theme objects, which often leads to inconsistent design implementation and difficult onboarding.

Core Features & Use Cases

  • Automated Token Extraction: Scans codebases to identify and extract design tokens from CSS, Tailwind, MUI, Chakra, and other styling systems.
  • Standardized Documentation: Generates a comprehensive DESIGN.md file that serves as a single source of truth for visual language.
  • Use Case: A team onboarding to a legacy project can use this skill to instantly generate a design system inventory, allowing them to make design-consistent decisions without manual archaeology.

Quick Start

Run the design-system-documenter skill to scan the current directory and generate a new DESIGN.md file based on the detected styling system.

Frequently Asked Questions about design-system-documenter

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

FAQPage Schema
How do I extract design tokens from CSS and Tailwind to create documentation?

Extract design tokens from CSS and Tailwind by scanning codebases to identify styling configurations, reconciling values into a standardized DESIGN.md artifact. This process generates human-readable design system documentation, serving as a single source of truth for visual language.

Can I generate a design system inventory for a legacy project with scattered theme objects?

Generate a design system inventory for legacy projects with scattered theme objects by scanning source files to extract tokens. This produces a comprehensive DESIGN.md file, allowing teams to make design-consistent decisions without manual archaeology during onboarding.

Does design token documentation work with MUI and Chakra configurations?

Design token documentation works with MUI and Chakra configurations by operating across web and mobile frameworks to reconcile token values. It extracts tokens from diverse styling systems and maps provenance into a unified, human-readable design system artifact.

What is the best way to document semantic token naming conventions and accessibility contrast?

Document semantic token naming conventions and accessibility contrast by extracting tokens from source files and verifying contrast ratios. This satisfies design system requirements by mapping provenance and standardizing semantic names within the generated DESIGN.md artifact.

How do I consolidate fragmented design tokens into a single source of truth?

Consolidate fragmented design tokens into a single source of truth by scanning configuration files and CSS to extract values. This generates a standardized DESIGN.md artifact that reconciles diverse styling configurations into unified, human-readable documentation.

Do I need manual setup to scan my directory and generate a DESIGN.md file?

Manual setup is not required to scan a directory and generate a DESIGN.md file. Running the automated extraction process detects the styling system in the current directory and instantly produces a comprehensive design token inventory without manual archaeology.