关于 docs-js
这项文档查询技能面向 Vanilla JavaScript 中的 IMG.LY CreativeEditor SDK。它引导 Agent 查阅指定版本的文档、API 参考和本地规则,并要求答案仅依据读取的资料。
主要功能
- 01定位相关 SDK 文档
- 02以 Markdown 获取文档
- 03查询 TypeScript API 详情
- 04查阅本地实现规则
- 05检查 SDK 版本指引
适用场景
- 01查找 Vanilla JavaScript SDK 用法
- 02核对 API 签名与类型
- 03回答功能能力相关问题
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ imgly/ agent-skills --skill docs-js安装后在 Claude Code 中输入/docs-js确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/js.mdupdate-check.mdrules/asset-handling.mdcommon-pitfalls.mdcontent-fill-mode.mdsilent-init-errors.mdverify-properties-before-use.md详细介绍
版本说明
CE.SDK
1.83.0· 生成日期:2026-09-30· 插件cesdk· 规范更新源imgly/agent-skills。如果此软件包已超过六周,或用户询问更新,请在每项任务中执行一次
references/update-check.md中的检查,并将结果用于所有 CE.SDK 技能。检查时仅进行只读操作。未经用户明确批准,绝不安装、更新、覆盖或删除任何内容。 除非用户批准更新,否则继续使用此软件包。
CE.SDK Vanilla JavaScript 文档
查找 IMG.LY CreativeEditor SDK(Vanilla JavaScript)的文档。
查询:$ARGUMENTS
远程文档
此技能会读取 https://img.ly/docs/cesdk/js/ 上的 CE.SDK 文档。
该网站仅提供最新的稳定版 CE.SDK,没有较早版本。
此软件包针对 CE.SDK 1.83.0。如果项目使用其他 CE.SDK 版本,
请阅读变更日志和升级页面,并检查已安装软件包的类型定义。
使用方法
- 阅读索引:阅读
references/js.md。其中列出了所有 Vanilla JavaScript 页面及其 标题和链接。 - 选择页面:挑选与查询相关的页面。
- 以 Markdown 格式获取各页面:删除链接末尾的
/,再添加.md。 例如,https://img.ly/docs/cesdk/js/export-save-publish/export/to-png-f87eaf/会变为https://img.ly/docs/cesdk/js/export-save-publish/export/to-png-f87eaf.md。 使用 WebFetch。如果 WebFetch 不可用(例如在 Codex 中),请使用curl -sL <url>。 - 仅根据获取的页面作答:提供相关章节和代码示例,并引用页面 URL。如果没有页面涵盖 用户的问题,请如实说明。不要用预训练知识填补空缺。
- 检查规则:在进行设置、初始化或常见操作之前,请阅读本地
rules/*.md文件。这些文件列出了网站文档未涵盖的 Agent 易犯问题。
API 查询
对于 TypeScript API 查询(方法签名、类型、参数):
- Editor API(
@cesdk/cesdk-js):https://img.ly/docs/cesdk/js/api/cesdk-js.md - Engine API(
@cesdk/engine):https://img.ly/docs/cesdk/js/api/engine.md
类和类型页面遵循相同的 .md 规则。例如:
https://img.ly/docs/cesdk/js/api/engine/classes/blockapi.md。
提示:请对照 TypeScript 定义验证类型——CE.SDK 迭代迅速,类型结构可能与预训练知识不同。
全文
https://img.ly/docs/cesdk/js/llms-full.txt 包含一个文件中的所有 Vanilla JavaScript 页面
(数 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`