SuperAPI AI 工具集

api-reference

写作与研究

查看项目

更新于 10-16 05:47

技能介绍

用途:为 Video.js 10 的组件或工具 API 搭建完整的 API 参考页面。

用法:/api-reference [name],name 可选,使用 kebab-case 组件名(如 play-button)或工具名(如 use-player),省略时会提示输入。

主要能力:按需加载 references 中的约定文件(builder-conventions、util-conventions、mdx-structure、demo-patterns 等),并结合 component、aria、docs、api 等相关技能。

组件流程:读取核心文件与 data-attrs 文件,检查是否为多部件,查找设计文档,读取 HTML 元素文件,可选通过 git log 与 gh pr list 补充关联 PR 上下文;运行 pnpm -F site api-docs 校验生成 JSON(props、state、dataAttributes、platforms.html.tagName 等),缺失或不完整时诊断命名约定问题并提出修复;决定需包含的说明段落(行为、样式、无障碍等);在 HTML 与 React 中创建 demo(HTML 4 个文件、React 2 个文件,遵循 BEM 命名,CSS 用 data 属性选择器,React 用 render prop);创建 MDX 页面并加入侧边栏,最后运行 pnpm dev 验证。

工具流程:确保工具从被扫描的包索引导出并带 JSDoc,必要时添加 @public;运行 pnpm -F site api-docs 生成并校验 JSON;创建 MDX 页面并加入对应侧边栏分区。

适用场景:为 Video.js 10 组件与工具补充标准化 API 参考文档。

限制:依赖仓库内部路径与命令;demo 使用的视频与封面为给定 URL。其他细节暂未提供。