design-system-documenter
OfficialGenerate developer-ready design system docs.
Authorcuriositech
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill bridges the gap between raw design tokens and developer adoption by creating comprehensive, developer-friendly documentation for design systems.
Core Features & Use Cases
- Token Reference Tables: Generates tables detailing token names, values, usage, and accessibility.
- Usage Guidelines: Provides clear instructions on when and how to use tokens, including code examples.
- Visual Examples: Demonstrates token application through visual swatches and interactive elements (in MDX/Storybook).
- Accessibility Notes: Highlights contrast ratios and reduced motion considerations.
- Do/Don't Examples: Prevents misuse by showing common mistakes and correct patterns.
- Output Formats: Supports Markdown, MDX, and Storybook documentation.
- Use Case: After generating design tokens with
design-system-generator, use this Skill to automatically create a documentation page for your design system, making it easy for developers to understand and implement the tokens.
Quick Start
Use the design-system-documenter skill to create markdown documentation for the tokens in 'tokens.json'.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: design-system-documenter Download link: https://github.com/curiositech/some_claude_skills/archive/main.zip#design-system-documenter Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.