跳转到主要内容
编辑器设置页面控制外观、发布行为和智能体行为。
  • Appearance：关于编辑器外观和行为的个人偏好，仅对你生效。
  • Publishing：整个项目范围内的默认设置，决定编辑器如何提交更改和打开 pull request，对所有发布者生效。admins 和 editors 都可以更新发布行为。在 Enterprise 方案中，只有 admins 可以更改 Auto publish 和 Require review before publishing。
  • Chat：编辑器 AI 智能体的持久说明。
  • Danger zone：无法撤销的操作。

​
Appearance

外观设置是个人偏好。它们只会为你改变编辑器，不会影响团队成员或你已发布的站点。所有外观设置默认关闭。
  • Fit editor to full width：让编辑画布横向铺满，而不使用默认的 768px 栏宽。
  • Show breadcrumbs：在编辑画布上方显示该页面在站点导航中的位置。
  • Open live preview in new tab：预览时在新的浏览器标签页中打开渲染后的页面。

​
PR 合并方式

选择点击 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 上的更改提交。如果启用该设置，编辑器会为你站点上的所有人隐藏分支和发布步骤。自动发布默认关闭。
启用自动发布后，没有待处理状态，也没有审阅机会。你停止输入后不久，每次编辑都会进入你的线上站点。
开启自动发布会关闭发布前要求审阅。

​
发布前要求审阅

要在发布前要求审阅，你必须使用 Enterprise 方案，并且项目的仓库必须托管在 GitHub 上。
当你要求发布前审阅时，只有 admins 可以直接向 deployment branch 发布更改。其他所有人都必须请求审阅，且审阅者必须先批准更改，admin 或 publisher 才能发布这些更改。有关请求和批准的工作方式，请参阅发布前要求审阅。该设置默认关闭。
  • 只有 admins 可以开启或关闭该设置。
  • 要求发布前审阅会关闭自动发布。
  • 如果 deployment branch 启用了分支保护，你的仓库必须托管在 GitHub.com 上。此时审阅会在分支上进行，admins 无法不经审阅直接发布。请参阅在受保护的 deployment branch 上审阅。
  • 审阅适用于你的 deployment branch 以及你在编辑器中创建的分支。在分支上，审阅者批准所有已更改的页面后，admin 或 publisher 即可发布。请参阅审阅 branch 上的更改。

​
默认创建草稿 pull request

启用该设置后，从编辑器创建的 pull request 会以草稿形式打开，包括新分支上首次提交后打开的 pull request。作者在完成编辑后点击 Request review，将其标记为可供审阅。该设置默认启用。 如果你希望从编辑器创建的 pull request 一打开就处于可供审阅状态，请关闭草稿 pull request。

​
为提交添加共同作者

启用此设置后，编辑器创建的每个提交都会将做出更改的人添加为共同作者。GitHub 等 Git 提供商随后会将做出更改的人和 Mintlify bot 一同列为该提交的共同作者。此设置默认关闭。 如果你已将 GitHub 账户连接到 Mintlify，共同作者署名会使用你的 GitHub no-reply 邮箱地址。否则，会使用你 Mintlify 账户上的邮箱地址。

​
显示同事的更改

Show teammates’ changes 控制在 deployment branch 上 Publish 菜单是否列出同事的待处理更改。
该设置以前称为 Granular publishing。
  • 关闭（默认）：Publish 菜单仅列出你自己的更改。你可以选择要发布其中哪些。仅由同事所做的更改不会出现。
  • 开启：Publish 菜单还会列出同事的待处理更改，分为 Your changes 和 Modified by others，让你也可以发布这些更改。
该设置仅在你于 deployment branch 上工作、且该分支没有分支保护时生效。更多信息请参阅发布特定更改。

​
显示所有分支

显示所有分支控制分支菜单在你搜索之前列出哪些分支。
  • 关闭（默认）：分支菜单会列出你的 deployment branch、在编辑器中创建的分支，以及带有打开或草稿 pull request 的分支。已合并或已关闭的分支以及仓库中的其他分支，只有在你按名称搜索时才会显示。
  • 开启：分支菜单会列出所有分支，包括在编辑器之外创建的分支以及已合并或已关闭的分支。
更多信息请参阅管理分支。

​
AI 说明

AI 说明是编辑器随你的请求一并发送给 AI 的持久性指导。用它来固化你不想每次重复的风格和语气规则，例如语态、术语或格式约定。 你的说明适用于：
  • 从编辑器发起的智能体会话。
  • 评论线程中的 @mintlify 回复。
每位成员都维护自己的说明，与其用户账户绑定。说明的长度上限为 20,000 个字符。 当你发现自己在提示中反复给出相同的指导时，就可以添加 AI 说明，例如：
  • 要求使用第二人称或句子式大小写标题。
  • 指定特定的产品名称或术语。
  • 禁止营销语言或填充性表述。
  • 要求使用特定组件，例如始终用 <Note> 表示提示。
保持说明简短且具体。AI 会在每次请求时遵循这些说明，因此含糊或相互矛盾的规则会降低效果。 示例：
清空该字段即可移除你的说明。

​
重置编辑器

Reset editor 会强制编辑器丢弃本地状态，并与你的 Git 仓库重新同步。确认之后，编辑器会重新加载。admins 和 editors 都可以重置编辑器。 如果编辑器与仓库持续不同步，请重置编辑器，例如文件树为空或出现 Unable to find docs.json 之类的错误。即使该文件确实存在于 deployment branch 上、线上站点也能正常构建，仍可能出现这种情况。
如果你重置编辑器，会丢弃所有尚未提交到 Git 的未发布更改。如果有想保留的待处理编辑，请先发布它们。