SuperAPI AI 工具集

repo-website-guide-create

前端与建站

查看项目

更新于 10-16 02:39

技能介绍

用途:在 Valibot 网站 website/src/routes/guides/ 下创建概念文档与教程页面,例如关于 schema、管道(pipeline)、解析等主题的指南。

主要能力与目录结构:指南按分类文件夹组织,分类文件夹使用括号(Qwik 路由分组),例如 (get-started)、(main-concepts)、(schemas)、(advanced)、(migration)。每个指南位于 (category)/guide-slug/index.mdx。同级还有 menu.md 用于导航菜单。

使用方式:先查阅目标分类下 2-3 个现有指南以理解风格;选择或新建分类;创建 (category)/guide-slug/ 文件夹并编写 index.mdx;最后更新 menu.md。index.mdx 的 frontmatter 必需字段为 title、description(多行可用 >-)、contributors(GitHub 用户名数组)。正文可用 import { ApiList, Link } from '~/components';。代码示例使用 TypeScript,统一以 import * as v from 'valibot'; 导入。内部链接使用 Link 组件,如 <Link href="/api/pipe/">pipe</Link>;可用 <ApiList label="Related schemas" items={['object', 'array', 'string']} /> 列出相关 API。

写作与格式规范:采用对话式叙述而非简略参考文档风格;使用第一人称复数(如 "we recommend");标题层级正确(h1 标题、h2 小节、h3 子小节);API 名、变量名、文件名用行内代码;仅将粗体用于真正的强调,不用作行内小节标签;引用块不加粗体前缀;列表项不需粗体前缀。图片与 index.mdx 同目录,可考虑明暗主题变体(如 diagram-light.jpg、diagram-dark.jpg)。

限制:资料未提供该技能的具体安装命令、收费或价格信息;未提供贡献者、许可证等细节。仅适用于 Valibot 网站仓库结构,其他项目需自行确认目录约定。