title: 如何在文档里放图片 description: 说明 AI Agent 入门文档库中的图片目录、相对路径写法、截图命名和安全检查。 keywords:
- Markdown 图片
- 文档截图
- 图片路径
如何在文档里放图片
这套文档支持图片。图片主要用于说明界面位置、按钮、配置结果和排错截图，不用于装饰。
图片放哪里
统一放在：
docs/assets/images/
如果某个专题图片很多，可以在这个目录下再建子目录，例如：
docs/assets/images/arai/
docs/assets/images/codex/
docs/assets/images/cc-switch/
Markdown 写法
从当前页面到图片使用相对路径。
例如 docs/arai/register-login.md 引用 ARAI 注册截图：
例如 docs/codex/setup-codex.md 引用 Codex 截图：
文件命名规则
文件名用小写英文、数字和连字符：
arai-register-page.png
codex-config-example.png
cc-switch-provider-list.png
不要使用空格、中文标点或过长文件名。
Prompt 占位说明
如果文档已经知道需要截图，但真实图片还没有补齐，可以先写 Markdown 图片引用，并在同目录创建同名 .prompt 文件。
例如文档引用：
则同时创建：
docs/assets/images/arai/arai-register-page.png.prompt
.prompt 文件用于说明后续截图应该展示什么、重点看哪里、需要遮挡哪些敏感信息。真实截图补齐后，可以按项目需要保留或删除 .prompt 文件，但不能提交包含敏感信息的图片。
截图前检查
截图前一定要遮住：
- API Key
- 邮箱完整地址
- 手机号
- 订单号
- 付款二维码
- 私人项目路径
- 客户名称或敏感数据
图片使用规则
适合放图片：
- 注册页字段很多。
- 控制台入口容易找不到。
- 配置成功状态需要对照。
- 错误提示需要定位。
不适合放图片：
- 只是重复正文文字。
- 含有敏感信息。
- 很快会过期的价格或活动信息。
验证结果
新增图片后检查：
- 图片文件确实存在。
- 如果真实图片还没补齐，同名
.prompt文件已经存在。 - Markdown 路径能从当前页面走到图片。
- 图片没有泄露密钥、订单或个人信息。
- 图片说明文字能让读者知道它在展示什么。