用途:这是 React 官方文档站(react.dev)的 MDX 组件规范,供文档作者在撰写参考页、Learn 页和博客页时统一使用各类提示、代码示例与练习组件。
主要能力:提供组件决策速查表,按需求选用 <Note>(提示)、<Pitfall>(常见错误)、<DeepDive>(进阶讲解)、<Canary> 或 <CanaryBadge />(Canary 特性)、<RSC>(仅服务端组件)、<Deprecated>(已废弃 API)、<Wip>(实验性)、<Diagram>(图示)、<Recipes>(多示例)、<Sandpack>(交互代码,另见 /docs-sandpack)、<ConsoleBlock>(控制台错误)、<Challenges>(页末练习,仅 Learn 页)。同时规定标题层级:DeepDive 用 ####、带标题 Pitfall 用 #####、带标题 Note 用 ####、Recipe 与 Challenge 条目用 ####。
使用方式:调用组件时须遵循空白行与并列规则。Note、Pitfall、DeepDive 开标签后需空一行再写内容;不得连续放置两个 Pitfall 或两个 Note,可合并为带标题子节或用正文分隔;DeepDive 连排、Pitfall 后接 DeepDive 属允许的。Challenges 仅出现在标准 Learn 页末尾,且每条练习需含问题与解答 Sandpack。Reference 页中 <RSC> 置于 <Intro> 之前,页面级 <Deprecated> 置于 <Intro> 之后,方法级紧随方法标题。<CodeStep> 需克制使用,一次解释最多 2 至 3 种颜色。
适用场景:React 文档仓库的贡献者与文档维护者、需要保持文档风格一致的技术写作者,以及学习其组件化文档模式的团队。
限制:资料未提供安装命令、依赖版本、许可与收费信息,暂未提供;部分组件的完整属性与更多示例需查阅现有文档。