关于 docs-electron
这是用于查询 Electron 版 IMG.LY CreativeEditor SDK 文档的技能。它引导 Agent 查找对应版本的文档、API 参考和本地规则,并要求回答以实际获取的文档为依据,而非依赖预训练知识。
主要功能
- 01查找相关 Electron 文档页面
- 02以 Markdown 获取文档
- 03查询 TypeScript API 参考
- 04查阅本地实现规则
- 05依据引用文档作答
适用场景
- 01查询 CE.SDK Electron API
- 02查看设置和使用说明
- 03核对方法签名与类型
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ imgly/ agent-skills --skill docs-electron安装后在 Claude Code 中输入/docs-electron确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/electron.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 Electron 文档
查阅 IMG.LY CreativeEditor SDK(Electron)文档。
查询:$ARGUMENTS
远程文档
此技能会从 https://img.ly/docs/cesdk/electron/ 读取 CE.SDK 文档。
该网站只提供最新的稳定版 CE.SDK,没有旧版本。
此套件面向 CE.SDK 1.83.0。如果项目使用不同版本的 CE.SDK,
请阅读变更日志和升级页面,并检查已安装软件包的类型定义。
使用方法
- 阅读索引:读取
references/electron.md。其中列出了所有 Electron 页面及其 标题和链接。 - 选择页面:选择与查询相符的页面。
- 以 Markdown 格式获取每个页面:从链接中删除末尾的
/,并添加.md。 例如,https://img.ly/docs/cesdk/electron/export-save-publish/export/to-png-f87eaf/会变成https://img.ly/docs/cesdk/electron/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/electron/api/cesdk-js.md - Engine API(
@cesdk/engine):https://img.ly/docs/cesdk/electron/api/engine.md
类和类型页面也遵循相同的 .md 规则。例如:
https://img.ly/docs/cesdk/electron/api/engine/classes/blockapi.md。
提示:请根据 TypeScript 定义验证类型——CE.SDK 更新很快,类型结构可能与预训练知识不同。
全文
https://img.ly/docs/cesdk/electron/llms-full.txt 包含一个文件中的所有 Electron 页面
(数 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`