编辑器的 AI 与发布设置
配置编辑器外观、AI 说明和发布默认值,以控制 Mintlify 网页编辑器的显示方式,以及它提交和合并更改的方式。
编辑器设置页面控制外观、发布行为和智能体行为。
- Appearance:关于编辑器外观和行为的个人偏好,仅对你生效。
- Publishing:整个 deployment 范围内的默认设置,决定编辑器如何提交更改和打开 pull request,对所有发布者生效。只有 admins 才能更新发布行为。
- Chat:编辑器 AI 智能体的持久说明。
- Danger zone:无法撤销的操作。
外观设置是个人偏好。它们只会为你改变编辑器,不会影响团队成员或你已发布的站点。所有外观设置默认关闭。
- Fit editor to full width:让编辑画布横向铺满,而不使用默认的 768px 栏宽。
- Show breadcrumbs:在编辑画布上方显示该页面在站点导航中的位置。
- Open live preview in new tab:预览时在新的浏览器标签页中打开渲染后的页面。
选择点击 Merge and publish 时编辑器合并 pull request 的方式:
- Merge:创建一个保留完整分支历史的合并 commit。这是默认选项。
- Squash:把分支上的所有 commit 合并为 deployment branch 上的单个 commit。
- Rebase:把分支上的每个 commit 依次重放到 deployment branch 上,不创建合并 commit。
让合并方式与 Git 提供方的分支保护设置保持一致。如果 deployment branch 只允许 squash merge,请将该方式设为 Squash,以免从编辑器合并时失败。
自动发布会在你停止编辑后不久,自动把 deployment branch 上的更改提交。如果启用该设置,编辑器会为你站点上的所有人隐藏分支和发布步骤。自动发布默认关闭。
启用自动发布后,没有待处理状态,也没有审阅机会。你停止输入后不久,每次编辑都会进入你的线上站点。
启用该设置后,从编辑器创建的 pull request 会以草稿形式打开,包括新分支上首次提交后打开的 pull request。作者在完成编辑后点击 Request review,将其标记为可供审阅。该设置默认启用。
如果你希望从编辑器创建的 pull request 一打开就处于可供审阅状态,请关闭草稿 pull request。
分级发布控制在 deployment branch 上 Publish 菜单显示哪些待处理更改。
- 关闭(默认):Publish 菜单仅显示并发布你自己的更改。仅由同事所做的更改会被隐藏。
- 开启:Publish 菜单会显示所有人的待处理更改,分为 Your changes 和 Modified by others,每项更改都带有复选框,让你可以选择要发布的内容。
该设置仅在你于 deployment branch 上工作、且该分支没有分支保护时生效。更多信息请参阅发布特定更改。
PR 说明会在 AI 生成 pull request 标题和描述时提供指导。只要编辑器代表你生成 pull request 描述,这些说明就会生效。
使用 PR 说明来统一审阅者看到的内容,例如:
- 必需的分区,如 Summary 和 Changes。
- 链接到跟踪系统的描述模板。
- 对标题的语气或长度要求。
示例:
Title: imperative mood, under 70 characters, no trailing period.
Description: include a "## Summary" section (one sentence) and a
"## Changes" section as a bulleted list. Link any referenced page
using its relative path.说明的长度上限为 20,000 个字符。
AI 说明是编辑器随你的请求一并发送给 AI 的持久性指导。用它来固化你不想每次重复的风格和语气规则,例如语态、术语或格式约定。
你的说明适用于:
- Ask AI 提示,通过在空行按 Space 打开。
- 从编辑器发起的智能体会话。
每位成员都维护自己的说明,与其用户账户绑定。说明的长度上限为 20,000 个字符。
当你发现自己在提示中反复给出相同的指导时,就可以添加 AI 说明,例如:
- 要求使用第二人称或句子式大小写标题。
- 指定特定的产品名称或术语。
- 禁止营销语言或填充性表述。
- 要求使用特定组件,例如始终用
<Note>表示提示。
保持说明简短且具体。AI 会在每次请求时遵循这些说明,因此含糊或相互矛盾的规则会降低效果。
示例:
- Use second person ("you") and active voice.
- Use sentence case for all headings.
- Refer to the product as "Acme"—never "Acme Inc." or "the platform".
- Wrap notes and warnings in <Note> or <Warning> components.
- Do not add introductory filler like "In this guide" or "Let's explore".清空该字段即可移除你的说明。
Reset editor 会强制编辑器丢弃本地状态,并与你的 Git 仓库重新同步。确认之后,编辑器会重新加载。只有 admins 才能重置编辑器。如果编辑器与仓库持续不同步,请重置编辑器,例如文件树为空或出现 Unable to find docs.json 之类的错误。即使该文件确实存在于 deployment branch 上、线上站点也能正常构建,仍可能出现这种情况。
如果你重置编辑器,会丢弃所有尚未提交到 Git 的未发布更改。如果有想保留的待处理编辑,请先发布它们。