component-docs-writer
OfficialCraft perfect component docs, effortlessly.
Software Engineering#documentation#design system#developer experience#content generation#component#mdx
Authormarigold-ui
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill streamlines the creation of high-quality, consistent documentation for Marigold Design System components, ensuring clarity, accuracy, and adherence to best practices.
Core Features & Use Cases
- MDX Documentation Generation: Writes comprehensive MDX files for components, patterns, and foundations.
- Interactive Demo Creation: Generates
.demo.tsxfiles to showcase component functionality. - Anatomy Diagram Guidance: Provides instructions and patterns for creating clear SVG anatomy diagrams.
- Use Case: When a new
Avatarcomponent is developed, this Skill can generate its initial MDX structure, anatomy diagram placeholders, and basic demo files, significantly speeding up the documentation process.
Quick Start
Use the component-docs-writer skill to create documentation for a new Button component.
Dependency Matrix
Required Modules
None requiredComponents
referencesassetsscripts
💻 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: component-docs-writer Download link: https://github.com/marigold-ui/marigold/archive/main.zip#component-docs-writer 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.