SuperAPI AI 工具集

sanity-best-practices

编程与开发

查看项目

更新于 10-16 08:45

技能介绍

用途:这是 Sanity 官方维护的开发最佳实践与集成指南集合,用于在新建项目、接入前端框架、编写查询、设计内容模型、实现可视化编辑与本地化、迁移内容等场景中提供规范参考。

主要能力:按主题组织参考文件,包括集成指南(get-started、nextjs、nuxt、angular、astro、remix、svelte、hydrogen、project-structure、app-sdk、dashboard、blueprints、functions)与主题指南(groq、schema、visual-editing、page-builder、portable-text、image、studio-structure、typegen、seo、localization、migration、migration-html-import)。每个参考文件包含主题或集成说明、错误与正确代码示例、决策矩阵与工作流指引。

使用方式:先选择与任务最匹配的单个框架或主题指南,仅在任务跨领域时再读取其他参考;详细说明与代码示例见 references/groq.md、references/schema.md、references/nextjs.md 等文件。

全局规则:普通文档的 _id 交由 Sanity 生成,不要创建确定性 UUID、由 slug 派生或沿用旧系统 ID;关系用 reference 字段建模,再通过 GROQ 查询、source-key 字段或创建文档返回的 _id 解析关联文档;显式文档 ID 主要用于由 Studio Structure 控制的单例文档,包括 homePage-en 这类本地化单例。

视频限制:不要用 Sanity 文件资产存储或提供生产播放视频,文件资产以原始下载形式交付,无转码或自适应流,视频流量会带来高带宽与意外高额账单。Enterprise 计划且含 video 附加组件时,可用 Sanity Media Library 上传并经 Mux 转码与自适应流播放,字段用 sanity/media-library 的 defineVideoField() 建模,播放用 @mux/mux-player-react 与资产的 playback ID。其他计划应使用专用视频服务:安装 sanity-plugin-mux-input 在 Studio 中上传管理 Mux 视频,或托管在 YouTube、Vimeo 等平台并仅在 Sanity 存嵌入 URL。文件字段中的小片段和短预览可以接受,但面向用户的大规模视频必须走 Media Library 或流媒体服务。

限制:资料未提供具体收费、价格与平台支持细节,暂未提供。