SuperAPI AI 工具集

docs-writer-blog

写作与研究

查看项目

更新于 10-16 01:27

技能介绍

该技能适用于在 src/content/blog/ 目录下撰写或编辑文件,提供 React 官方博客的文章结构与约定。语气为 React 团队官方口吻,要求准确、专业、前瞻;风格细节需调用 /docs-voice,MDX 组件模式需调用 /docs-components。

Frontmatter 使用 YAML:title(带引号字符串)、author(不加引号,多人用逗号加 and)、date(YYYY/MM/DD,斜杠分隔)、description(1-2 句)。Frontmatter 之后紧跟署名行,格式为“Month DD, YYYY by 作者”,团队文章链接 /community/team,个人作者链接 Twitter/X 或 Bluesky,多位作者在 and 前加牛津逗号,随后接水平线 ---。

所有文章统一结构:Frontmatter、署名、水平线、<Intro> 组件(1-3 句)、可选水平线、带 ID 的 H2 正文、结尾章节(Changelog、Thanks 等)。文章类型模板包括:正式版发布公告、升级指南、React Labs 研究更新、React Conf 回顾、功能/工具公告、安全公告。标题模式随类型不同,如发布为 “React vX.Y”,升级为 “React [VERSION] Upgrade Guide”,Labs 为 “React Labs: [Topic] – [Month Year]” 等。

所有标题需带 CSS 注释式 ID:## 标题 {/heading-id/},ID 小写、kebab-case、去特殊字符。常用组件有 <Intro>(必需)、<Note>、<Pitfall>、<DeepDive>、<TerminalBlock>、<ConsoleBlock>、<ConsoleBlockMulti>、<YouTubeIframe>、<Diagram>、<InlineToc />。链接有内部(博客、API 参考、Learn、社区)与外部(GitHub PR、用户、Twitter/X、Bluesky、CVE、npm 包)两类模式。

约定要求:以事实为先,未发布功能明确标注“upcoming”,致谢贡献者并链接 GitHub,团队文章用“we”,避免夸张用语和重组件嵌套;标题 ID 与 <Intro> 为必需;安全文章须包含“We recommend upgrading immediately”;更新旧文不得破坏 URL,应添加更新说明而非改写历史。