storybook-component-documentation
OfficialGenerate crystal-clear component docs, automatically.
AuthorTheBushidoCollective
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill helps you create comprehensive, auto-generated component documentation in Storybook, ensuring that your UI components are well-understood and easily usable by all team members. It automates the process of documenting components.
Core Features & Use Cases
- Autodocs Integration: Automatically generate documentation pages from your existing stories with minimal configuration.
- Rich JSDoc Support: Document component props and types using JSDoc comments, which Storybook automatically extracts for detailed API tables.
- MDX Customization: Create custom documentation pages with MDX, allowing for rich text, live code examples, and interactive stories alongside your auto-generated content.
- Use Case: A new developer joins the team and needs to understand how to use a complex
DataTablecomponent. Instead of sifting through code, they can use the auto-generated documentation to see all props, their types, descriptions, and live examples, accelerating their onboarding and productivity.
Quick Start
Use the storybook-component-documentation skill to enable autodocs for a Card component and add JSDoc comments to its props for automatic API table generation.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 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: storybook-component-documentation Download link: https://github.com/TheBushidoCollective/han/archive/main.zip#storybook-component-documentation 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 471,000+ vetted skills library on demand.