用途:为组件库生成完整文档,涵盖 API 参考、用法示例、无障碍指南与设计规范,同时面向设计师与开发者。
主要能力:按固定结构组织文档,包括概述、何时使用、Props/API、示例、变体、状态、无障碍、设计规范、Do/Don't 等章节;提供组件文档模板与 TypeScript API 文档模板;可从 TypeScript 接口自动提取 props 并生成 Markdown 表格;给出文档站点目录结构建议。
使用方式:先确定组件范围,定义 props 接口,编写基础、进阶与边界示例,记录变体与状态,补充 ARIA、键盘与屏幕阅读器说明,加入间距、颜色、字体等设计令牌,最后写明使用与禁用场景。自动生成部分使用 TypeScript 编译器 API 读取接口与 JSDoc,输出 props 表格。
适用场景:记录新组件、创建组件 API 参考、编写用法指南、构建设计系统文档站点。
限制:资料未提供具体安装命令、运行环境要求、收费方式与平台支持信息;示例中的组件与令牌仅为模板示意,需按实际项目替换。