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