Skip to main content
编辑器内置了一个智能体,可以编辑页面、重新组织导航、更新 docs.json、在整个仓库中搜索,以及管理仪表板设置。 编辑器智能体会直接在你当前的分支上进行修改。

打开智能体

点击编辑器工具栏中的 Ask agent,或按 Cmd + I(macOS)或 Ctrl + I(Windows)。智能体可供 editors 和 admins 使用。Viewers 看不到 Ask agent 按钮。 输入 @ 提及特定页面,智能体就会聚焦该页面。如果没有提及,它会使用你当前打开的页面。 示例提示:
  • simplify the introduction page
  • fix all grammar errors across my content
  • add a new page that explains authentication
  • rename every mention of "Acme Pro" to "Acme Team" across all pages
  • update docs.json to add a new group called "Guides"

附加文件

点击聊天框中的回形针图标,或把文件拖放到面板上。智能体会把附加的文件作为你请求的上下文来读取。 支持的文件类型:
  • 图片:JPG、PNG、GIF、WebP、SVG
  • 文档:PDF
  • 代码和文本.js.ts.jsx.tsx.mdx.md.json.yaml.html.css、Python、Go、Rust、Ruby、Java、Swift、C、C++、SQL、shell 脚本等
大小上限:每个文件 5 MB,SVG 文件除外,其上限为 256 KB。每条消息最多 10 个文件。 在智能体读取 SVG 文件之前,Mintlify 会移除其中的脚本和其他活动内容。

把选中内容添加到智能体

在可视化模式下选中文本,然后点击浮动工具栏中的 Add to agent,即可把它作为上下文发送给智能体。

请求评论和建议

默认情况下,智能体会直接修改内容。如果你想获得反馈但暂时不改动页面,请明确要求它审阅页面、留下评论或提出建议。
  • 建议会提议一处具体的替换,你可以接受或拒绝。在你做出决定之前,原文会以删除线的形式保持可见,智能体还可以在建议线程中附上说明。
  • 评论会针对具体文本留下反馈或问题,不会修改页面。
示例提示:
  • review this page and leave suggestions
  • comment on anything that needs more context
  • suggest ways to make the introduction more concise
除非你指定其他页面,智能体会使用你当前打开的页面。它可以标注页面渲染后的文本,包括组件内部的正文。它无法标注 frontmatter、页面元数据、配置,以及原始的 MDX 组件标签和属性。

查看智能体的修改

智能体工作时,聊天中会出现 Changed files 面板。展开它可以查看本次会话中修改的所有文件,点击任意文件即可在 diff 视图中与原始版本进行比较。 若要撤销智能体的编辑,请点击 Changed files 面板中文件旁边的丢弃按钮,或丢弃本次会话的全部更改。

智能体能做什么

编辑页面

智能体可以在任意页面上撰写、改写、扩写和重新组织内容。它会阅读你已有的内容,以匹配你的风格和结构。

搜索和浏览内容

智能体可以在整个仓库中搜索,而不仅限于你打开的页面。你可以用它查找信息、检查不一致之处,或在新增内容前确认相关内容是否已经存在。

更新导航和 docs.json

智能体可以添加、重命名、重新排序和删除导航元素,与你在导航面板中手动进行的修改相同。它还可以直接更新 docs.json 配置,包括添加新的 group、调整设置和配置重定向。 示例:add a "Quickstart" group under the Getting Started tab and move the quickstart page into it

运行 bash 命令

智能体可以对你的仓库运行 greprg 等 bash 命令。适合跨多个文件的批量操作。 示例:find every page that mentions the deprecated /v1/auth endpoint

配置站点(code mode)

对于超出编辑页面范围的请求(例如设置认证、管理 workflow 或修改 deployment 设置),智能体会切换到 code mode。它会代表你编写并运行针对 Mintlify 仪表板的脚本。 Code mode 会遵循你在仪表板中的权限。如果你无权访问某项设置,智能体同样无法修改它。 使用 code mode 的示例提示:
  • enable JWT authentication for my site
  • create a workflow that updates my site when I merge a PR
  • add a custom domain

继续自动化运行

当你点击 Preview 从自动化结果打开编辑器时,智能体面板会自动打开,并带有该自动化所做工作的上下文。聊天顶部的 Changed pages 卡片会列出该自动化修改的所有页面。点击任意页面即可打开 diff 视图。 智能体掌握该自动化的提示、所做修改的摘要,以及它修改了哪些页面。你可以请它完善或延续这项工作,而无需重新说明背景。 例如:The new section on rate limits is too long. Trim it to three sentences.

会话历史

点击面板标题栏中的时钟图标,即可查看之前的聊天会话。点击任意会话可重新打开它,并查看智能体做了哪些修改。

AI 说明

若要为智能体提供持久性指导,例如语态规则、术语或格式约定,请在编辑器设置中配置 AI 说明。智能体会在每次请求时遵循这些说明,你无需重复说明。