mcpField
D
docs-svelte

docs-svelte

github.com/imgly开发984 次安装1 天前更新
代码仓库

关于 docs-svelte

docs-svelte 是面向 IMG.LY CreativeEditor SDK(Svelte)的文档查询技能,帮助 Agent 定位文档与 API 参考,并依据本地规则回答相关问题。

主要功能

  1. 01查询 Svelte 文档
  2. 02查询 TypeScript API 参考
  3. 03提供本地实现规则
  4. 04版本与更新指引

适用场景

  1. 01查找 Svelte 集成说明
  2. 02核对 BlockAPI 或 Engine API 细节
  3. 03检查资源与初始化注意事项

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/imgly/agent-skills --skill docs-svelte

安装后在 Claude Code 中输入/docs-svelte确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
svelte.md
update-check.md
rules/
asset-handling.md
common-pitfalls.md
content-fill-mode.md
silent-init-errors.md
verify-properties-before-use.md

详细介绍

版本说明

CE.SDK 1.83.0 · 生成时间:2026-09-30 · 插件:cesdk · 规范更新来源:imgly/agent-skills。

如果此捆绑包已超过六周,或用户询问更新,请在每项任务中按照 references/update-check.md 检查一次,并将结果用于所有 CE.SDK 技能。检查时仅执行读取操作。未经用户明确批准,绝不安装、更新、覆盖或删除任何内容。 除非用户批准更新,否则请继续使用此捆绑包。

CE.SDK Svelte 文档

查阅 IMG.LY CreativeEditor SDK(Svelte)的文档。

查询:$ARGUMENTS

远程文档

此技能读取 https://img.ly/docs/cesdk/svelte/ 上的 CE.SDK 文档。 该网站仅提供最新的稳定版 CE.SDK,没有旧版本。 此捆绑包适用于 CE.SDK 1.83.0。如果项目使用不同版本的 CE.SDK, 请阅读变更日志和升级页面,并检查已安装软件包的类型定义。

使用方法

  1. 阅读索引:阅读 references/svelte.md。其中列出了所有 Svelte 页面及其标题和链接。
  2. 选择页面:挑选与查询相关的页面。
  3. 以 Markdown 格式获取每个页面:从链接中移除末尾的 /,然后添加 .md。 例如,https://img.ly/docs/cesdk/svelte/export-save-publish/export/to-png-f87eaf/ 会变成 https://img.ly/docs/cesdk/svelte/export-save-publish/export/to-png-f87eaf.md。 使用 WebFetch。如果 WebFetch 不可用(例如在 Codex 中),请使用 curl -sL <url>。
  4. 仅根据获取的页面作答:提供相关章节和代码示例,并引用页面 URL。如果没有页面涵盖相关请求,请说明这一点。不要用预训练知识填补空缺。
  5. 检查规则:在设置、初始化或执行常见操作之前,请阅读本地的 rules/*.md 文件。这些文件列出了 Agent 可能遇到的问题,而网站文档未涉及这些内容。

API 查阅

对于 TypeScript API 查询(方法签名、类型、参数):

  • 编辑器 API(@cesdk/cesdk-js):https://img.ly/docs/cesdk/svelte/api/cesdk-js.md
  • 引擎 API(@cesdk/engine):https://img.ly/docs/cesdk/svelte/api/engine.md

类和类型页面也遵循相同的 .md 规则。例如: https://img.ly/docs/cesdk/svelte/api/engine/classes/blockapi.md。

提示:请根据 TypeScript 定义验证类型——CE.SDK 迭代迅速,类型结构可能与预训练知识不同。

全文

https://img.ly/docs/cesdk/svelte/llms-full.txt 包含所有 Svelte 页面,内容集中在一个文件中 (数 MB)。仅在索引和各页面都无法回答查询时,才将其作为最后手段。 使用 curl -sL <url> | grep -n "<keyword>" 搜索。不要全文阅读。

本地规则

  • rules/asset-handling.md:图像格式建议、URI 解析
  • rules/common-pitfalls.md:关键注意事项(不可见填充、SVG 渲染问题)
  • rules/content-fill-mode.md:contentFillMode 应设置在块上,而不是填充上
  • rules/silent-init-errors.md:CreativeEditor 初始化回调会静默吞掉错误
  • rules/verify-properties-before-use.md:获取或设置属性前,先调用 engine.block.findAllProperties()

其他适用场景

此技能也适用于有关 CE.SDK 块类型、资源源和功能能力的查询。 它还支持 API 方法查阅——BlockAPI、SceneAPI、EditorAPI、AssetAPI、方法签名、 返回类型,以及“engine.block”样式的查询。

相关技能

  • 用户需要实现方面的帮助,而不只是查阅文档时,请使用 `/imgly-sdk:build`
  • 对于超出文档范围的概念性说明,请使用 `/imgly-sdk:explain`

评论

支持 Markdown