Component Guidelines Documentation

关于

Streamline the creation and maintenance of high-quality design system documentation with this specialized tool designed for the SEED Design System. By parsing Rootage YAML specifications, it automatically generates comprehensive MDX files featuring property tables, component anatomy, and detailed usage guidelines. Whether creating documentation for simple UI elements or complex interactive components, it ensures consistency in structure, image naming conventions, and technical accuracy while providing specialized support for Korean language documentation and automated image optimization workflows.

主要功能

• 799 GitHub stars
• Enforces strict image naming and path conventions for design assets
• Generates standardized MDX documentation with consistent layouts for anatomy and guidelines
• Provides Korean language templates for professional tone and voice
• Includes built-in support for Do/Don't grids and platform status tables
• Extracts component props and specs automatically from Rootage YAML files

使用场景

• Creating initial guideline documentation for new design system components
• Updating existing documentation to reflect changes in component specifications
• Migrating component guides from V2 to V3 design system versions