重大发布
- 重大增强:在 404 页面提供 AI 推荐页面,当用户访问死链 → AI 代理读取路径 → 推荐语义相似的页面
- 重大发布:助手的网页搜索现在可包含外部来源
注意:请联系我们为你的网站启用此功能。
助手和 MCP
- 修复了由于时间窗口未正确滑动导致助手被错误限流的问题
- 修复了助手工具调用在处理空
text
块时的问题 - 修复了 MCP 服务器名称与工具调用拼接后有时会超过 MCP 客户端强制的 60 字符限制的问题
- 修复了助手菜单高度远大于视口并无限滚动的问题
- 修复了助手花费数值在仪表盘中显示超过两位小数的问题
网页编辑器与部署
- 增强了编辑器安全性,只有对连接的 git 托管仓库拥有
write permissions
的用户才能进行更改 - 修复了名称中包含
=
的分支无法进行预览部署的问题 - 修复了在创建预览部署时,过长的分支名称会在模态框中溢出的问题
- 体验优化:在注册邀请中,email 查询参数将预填输入框
- 修复了在 Safari 上通过上下文菜单复制页面不起作用的问题
API 操作台与导航
- 多个 API 操作台响应码在聚焦时现在显示于受控样式的选择菜单中,而非系统默认选择菜单
- 你现在可以在
docs.json
的导航分组上使用expanded
字段,使其默认展开
SEO 与 UI
- 通过将 favicon 与各文档站点本身使用相同的 URL 提供,修复了其在搜索引擎中不显示的问题
- 修复了 YouTube 嵌入在加载时闪烁的问题
- 修复了将反馈菜单展开以包含书面回复时导致目录发生布局位移的问题
- 修复了在 Maple 主题中,关闭通知横幅后文字会溢出到顶栏上方的问题
- 为 Maple 和 Willow 主题在侧边栏新增登录/登出按钮,提升易用性
分析与导出
- 修复了助手分析视图与导出的可靠性问题
- 助手分析导出现改为在后台执行,并通过邮件发送,以提供更可靠的体验
重要发布:增强的反馈收集
- 重大改进:读者在选择“点赞/点踩”后,现在可以提供更细化的反馈,包括选项和文字评论。你还可以对代码块收集反馈,并在仪表盘的分析中查看所有反馈。
注意:联系我方以为你的网站启用此功能。
导航与易用性改进
- 易用性改进:忽略尾部斜杠和双斜杠,你无需在 docs.json 中对其严格匹配
- 你现在可以在
h1-6
HTML 标签上添加noAnchor
属性,以避免生成锚点链接 - Palm 主题现在在左下角提供浮动语言选择器,类似于 Stripe 的做法
- 在 docs.json 中新增字段
drilldown
,用于控制当导航分组展开时,是否自动导航到该分组的第一页 - 易用性改进:使嵌套有序列表在十进制/罗马数字与字母样式之间交替
错误修复与可靠性
- 修复了当页面存在 JS 组件时,滚动位置锚点链接无法正常工作的问题
- 修复了 Google 会索引原始
*.md
文件的问题,原因是缺少x-robots-tag noindex
头 - 修复了受保护文档的 OAuth 问题:成功完成流程后不会重定向回起始页面
- 修复了受认证保护文档的预览中无法看到完整导航栏的问题
- 修复了使用新图像 CDN 处理 SVG 的相关问题
组件与样式增强
- 为
SidebarNavGroupDivider
新增 CSS 选择器,以便自定义样式 - 为在其上定义了安全性的、由 MDX 定义的 API 页面新增回归测试,以提升稳定性
性能改进
- 通过将 KaTeX CSS 从 cdnjs 迁移到我们在 CloudFront 上的自有 CDN,降低延迟并提升性能
图像处理改进
- 重大改进:即使未指定宽高属性,图像默认也不会引发布局偏移——自动尺寸可在页面加载时防止内容跳动
- 现在在部署时,代码库中的所有静态文件(PDF、TXT、XML 等)都会自动上传并提供服务,实现完整的资源覆盖
网页编辑器与部署增强
- 修复了网页编辑器中的分支创建流程,现可正确跳转至并停留在新建分支
- 增强了合并冲突对话框,支持正确的退出操作,无需再通过刷新页面来关闭冲突
- 通过在部分更新中仅对变更页面进行缓存失效,优化了更新流程性能,缩短部署时间
认证与导航改进
- 新增对自定义子目录的认证支持;如果你在
https://yourdomain.com/docs
提供文档,认证现在可无缝工作 - 修复了在仅配置一个链接时侧边栏仍会错误显示的问题
- 全面重构移动端导航:按钮居中并具备合理的边距/内边距,改进下拉菜单的间距,移除空分组中不必要的分隔线与边距,并修复 Maple 主题的间距/内边距问题
组件与样式修复
- 解决了将
<h1-6>
标签错误转换为 Heading 组件、从而破坏自定义样式的问题 - 在仪表盘中新增一键助手配置开关,便于管理
技术改进与可靠性
- 增强了更新流程的日志系统,加速调试与问题定位
- 通过从单文件抓取改为仓库克隆,解决了拥有 10+ OpenAPI/AsyncAPI 规范的客户在 GitHub 上的限流问题
- 通过备用 LLM 支持、改进的限流错误处理,以及更健壮的搜索工具,提升了助手的可靠性
性能与构建优化
- 在未缓存的 NextJS 无服务器环境中,MDX 转译现改为在部署时进行,而非在每次页面加载时进行,从而缩短未缓存页面的首字节时间(TTFB)。
- 基于内容的哈希在 MDX 未变化时可避免重复转译,将大量页面客户的更新流程耗时减少约 50%(超过 5 分钟的部署应能大致减半)
- 在仪表盘中查看预览部署更快了:我们在后端新增数据库索引并并行化查询
- 通过移除每个页面
rsc
负载中的重复navigation
数据来减小页面体积——在页面数量多或导航结构复杂时性能提升最明显 - 更激进的预取使即时加载更常见
API 操作台与 OpenAPI 增强
- 将 OpenAPI 到 MCP 的转换移至后端,使托管的 MCP 服务器能够包含工具(更清晰的文档与配置选项即将推出)
- 为 API 操作台新增 Ruby 支持
- 我们新增了一个功能,现在你可以仅通过 docs.json 指定 API 页面,无需创建任何新的 MDX 文件。
- 在文档导航中支持来自 OpenAPI 规范的
webhook
页面 - 在导航至 Anthropic、OpenAI 等提供方时,从 markdown 链接中移除锚点规范以优化 AI 模型上下文
网页编辑器改进
- 创建/重命名文件时,现在点击其他区域即可保存更改,无需按 Enter 键
- 修复了分支导航:将 URL 改为特定分支时会被重定向到上次活动分支而非目标分支的问题
- 对包含
/
的分支标题进行正确的 URL 编码,防止导航异常 - 修复了 monorepo 仪表盘编辑器中的
Ctrl+K
链接快捷键会在前面添加 docs 仓库路径并导致链接失效的问题
分析与 LLM 集成
- 支持自定义
llms.txt
和llms-full.txt
——将其添加到文档仓库根目录,即可通过/llms.txt
和/llms-full.txt
端点提供,供 LLM 定制使用 - 新增 Hightouch 分析集成
- 增强上下文菜单的分析跟踪(仪表盘视图即将上线)
- 为
llms.txt
和llms-full.txt
添加端到端测试,确保正确提供
组件与样式增强
h{1-4}
标签支持自定义 className,便于应用自定义标题样式- 修复了在自定义页面模式下,
h{1-4}
标签会渲染为带徽章的Heading
组件的问题 - 为面包屑添加 CSS 选择器,便于定向自定义
- 通过分析尺寸,在 56px 高度下保持比例,修复被拉伸的 open-graph 图片
- 在启用时,将上下文菜单中的
VSCode
更正为VS Code
- 修复了自定义组件内的标题与语义化标题同时出现在目录中的问题
Bug 修复与可靠性
- 通过清理导致生成问题的字符,修复了某些页面标题的 PDF 渲染问题
- 解决了在遇到空的 OpenAPI JSON 文件时出现的 CLI 错误
Cannot convert undefined or null to object
- 修复了自定义
docs.json
open-graph 元标签被生成标签覆盖的问题 - 通过对 RSS 链接使用 origin + pathname,修复了落到锚点链接时 RSS 订阅按钮点击的问题
- 通过移除 sourcemap 改进了 CLI 下载速度
技术改进
- 在 CI 流水线中添加可视化测试,以更早发现回归
- 增强错误处理与调试能力
- 为新功能与边界情况提供了更全面的测试覆盖
认证改进
- 组级公开访问:通过
docs.json
将整个页面组设为公开,这样无需在每个页面上单独设置public: true
(了解更多) - 在 OAuth 配置中支持
logoutURL
,用于删除上游 cookies 并完成登出 - 当发生 OAuth 错误时,用户会被重定向到你指定的
logoutURL
以重新开始认证流程 - 修复在回调前 OAuth/JWT 流程中短暂闪现 500 错误的问题
- 在 OAuth/JWT 认证配置中自动去除 URL 中的
https://
以防误配置
API 操作台增强
- 新增 Search API 端点,可在你的文档之上构建代理和 MCP 服务器
- 现已按配置的路径提供
openapi
和asyncapi
文件(例如https://mydocsurl.extension/{openapi-or-file-name}.json
) - 现在可以在 OpenAPI 文件中使用
x-mint
字段 来覆盖生成的字段、自定义前言内容,或更改代码示例中的端点 URL - 在 OpenAPI 配置中,
x-mcp
现为x-mint.mcp
,用于控制哪些路由以 MCP 工具形式暴露
助手更新
- 修复旧消息的操作菜单(包含复制、点赞等选项)在新消息流入时消失的问题
- 修复上周 托管 MCP 服务器发布 后嵌套的
/mcp/...
页面可访问性问题
性能与可靠性
- 文档仓库中的所有图片和视频资源现在都会在你的域名下以正确的路径提供。例如,如果仓库中有
/assets/marketing/my-logo.png
,则可在https://mydocsurl.extension/assets/marketing/my-logo.png
访问。 - Mintlify 仪表盘登录页的邮箱输入框现已自动聚焦,便于立即输入(体验优化)
- 在 Redis 中同时处理自定义域名和子域名,以提升导航加载性能(约 50ms 延迟降低)
- 为 PDF 导出添加重试逻辑以提升稳定性
- 修复在同意或关闭后 cookie 同意弹窗仍会再次出现的问题——现已尊重首次选择
- 通过在
navigator.write
中指定 MIMEtype
,修复在 Safari 上将页面复制到剪贴板的问题
技术改进
- 修复 Windows 与 pnpm 的 CLI 问题,并加入 CI 测试以防回归
- 改进错误日志输出——为工程团队调试带来更佳体验
- 当缺少
contentDirectory
文件时,修复 broken-link CI action 的若干小问题 - 修复上周认证保护的预览修复导致的回归问题:导航 UI 中未能正确设置活动选项卡
- 修复主题浅色背景未应用于活动选项卡图标的问题
- 修复在仪表盘中更改认证类型会先更新但随后回退至先前保存类型的问题——现在保存后新选择会持久保留
- 面向使用自定义 UI 库的企业客户的内部 DX 改进——我们现在能更快集成你的组件并在更短周期内满足需求
身份验证改进
- 改进本地环境下的身份验证开发流程,加速该领域功能迭代与缺陷修复
- 受身份验证保护的网站现已支持预览部署
- 修复重定向行为,用户完成身份验证后可正确返回原始页面
- 修复完整认证的登出按钮显示问题(此前仅在部分认证下有效)
API 操作台增强
- 修复 API 操作台中的
multipart/form-data
文件上传功能 - 修复锚点链接行为,点击后更新 URL 且不再滚动至页面顶部
- 修复嵌套选项卡中的锚点链接问题
助手更新
- 新增助手 API,便于你将其集成到自有产品,兼容 AI SDK
- 为聊天回复新增复制按钮
- 修复助手中重试消息的问题
- 优化默认助手提示,使其默认更简洁
性能与可靠性
- 通过在输入时中止去抖请求,让搜索更灵敏、结果更准确
- 为全新 CDN 预置资源——预计图片与页面加载时间将很快改善
- 修复渲染复杂 Mermaid 图(如甘特图)的缺陷
- 修复 Windows 上的 CLI 缺陷以提升稳定性,并新增测试防止回归
技术改进
- 在 NextJS 应用中加入 OpenTelemetry 跟踪,为客户缩短首字节时间
- 从 Octokit 迁移至 GitHub API Client,降低网页编辑器的延迟
- 修复 OpenGraph 的重复 meta 标签
- 将 MongoDB 从 6 升级至 7,带来更高性能与新特性
Slack 应用
- 零阻力接入:Bot 可响应私信、@提及,以及你在
#ask-ai
频道中的任何问题 - 一键设置:可在 Mintlify 仪表盘内秒级安装
- 上下文答案:搜索你的全部文档,提供相关且准确的回复
- 减少支持打扰:将日常问题转化为即时的自助式解答
托管 MCP 服务器
通过 Mintlify 直接部署托管的 MCP(模型上下文协议)服务器,与 Claude、Cursor 等 AI 工具集成。详见我们的 MCP 指南。通过上下文菜单,帮助用户在文档任意页面快速将你的 MCP 服务器连接到 Cursor 或 VS Code。参见上下文菜单了解更多信息。代码块改进
- 改进语法高亮
- 新增更多自定义选项,包括专注模式、可展开代码块、深浅色模式自适应、语言下拉菜单、行号和图标
网页编辑器 3.0

- 使用 ⌘ + P 快捷键按文件名搜索
- 页面加载速度提升 10 倍
- 搜索分支时加载更快
- 新增“页面选项”标签,用于配置布局、标题和 SEO 元数据
- 选中文本时显示浮动工具栏
- 修复了更新日志组件的顶部外边距
- 提升了右键操作的稳定性
- 点击发布后将停留在当前页面,不再跳转到空白状态
- 统一了文件图标的颜色
- 多次连续切换新分支后的稳定性提升
- 移除了 Diff 模式
- 通过下拉菜单创建新文件夹时行为更一致
- 修复了尝试取消选择时引用块会继续生成更多引用块的问题
AI 翻译(测试版)

导出文档为 PDF(测试版)
将你的全部文档、某个子目录或单个页面导出为 PDF。支持 React Hook
为你的文档带来交互性。所有标准 React Hook 会在你的 MDX 文件中自动可用。了解更多。MCP 服务器生成器

改进
- 为更新日志项添加标签,终端用户可据此筛选更新
- AI Chat 支持 Sonnet-3.7。可在仪表盘中配置你的首选模型
- 可在仪表盘设置中直接更改部署名称
错误修复
- 修复了 OG 图像
- 修复了无容器锚点的图标样式不一致问题
- 改进了仪表盘边框在移动端/平板/桌面端响应式下的样式细节
- 即使在简洁模式下也会显示 API 操作台中的代码示例
- 网页编辑器中支持 “command + k” 搜索快捷键
- 提示框(callout)内的代码块会扩展以填满提示框区域的宽度
新的配置模式 docs.json

docs.json
模式来替代 mint.json
,以提供更完善的多级版本管理、更易理解的结构,以及更一致的术语。了解更多变更详情,请查看我们的博客。按以下步骤从 mint.json
升级到 docs.json
:- 确保你的 CLI 为最新版本
- 在你的文档仓库中运行
- 删除旧的
mint.json
文件并推送你的更改
CI 检查
自动对你的文档进行 lint,查找失效链接、拼写与语法问题,或使用你自己的 Vale 配置来强制执行写作风格。查看我们的文档了解更多信息。面向 LLM 的 .md 支持
现在所有文档页面都会自动提供为纯 Markdown 文件——只需在 URL 末尾追加.md
。这使得 LLM 更容易摄取你文档中的单个页面。更多主题

- Maple
- Palm
- Willow
其他改进
- 技术写作指南:技术文档写作最佳实践,包括受众研究、内容类型与写作技巧。
- Dropdown 组件:除了选项卡与锚点外,支持用下拉菜单组织导航。
- AI 语法修复器:网页编辑器在检测到解析错误时,会使用 AI 提出修复建议。
November 2024
AI 写作

GitLab 集成升级
我们改进了与 GitLab 的同步支持,例如启用自动更新和预览部署。查看我们的GitLab 文档以开始使用。网页编辑器

/llms.txt 支持

本地化
你现在可以对文档进行本地化,其工作方式与版本管理类似。为某个版本添加一个locale
后,Mintlify 中的固定内容(如“此页面是否对你有帮助?”)也会匹配该 locale。质量改进
- 基于用户当前阅读的版本返回聊天和搜索结果
- 在 JWT 或共享会话令牌之外,新增对 OAuth 的用户认证支持。
October 2024
更新日志
上线全新的 Update 组件,让你更轻松地向用户展示和发布更新(如本条)。
代码行高亮
你现在可以在文档中高亮代码行:在语言标识符后添加特殊注释,用花括号{}
指定行号或用逗号分隔的行号区间。Line Highlighting Example
浅色模式代码块
代码块现在提供浅色模式变体,可通过在docs.json
中添加以下配置启用:高级页脚

基于当前用户的搜索过滤
启用个性化后,搜索结果会基于当前登录用户进行过滤,确保只看到相关内容。AI 聊天自定义提示词
你现在可以自定义 AI 聊天的提示词。如需配置,请联系 support。仪表盘改进
- 新增在仪表盘设置中将自定义域名直接指向 /docs 的能力。
- 合并登录与注册页面,降低阻力与困惑。
- 实现发现式登录流程,支持属于多个组织的用户在其间切换。
- 新增使用 Google OAuth 登录。
- 新增可在仪表盘设置中添加新部署。
错误修复
- 导航中现已支持以斜杠开头的路径。
- 现可在网页编辑器中编辑 CSS 与 JS 文件。
- 修复启用后
suggestEdit
仍不显示的问题。 - 修复搜索和聊天的键盘导航,现在可用上下方向键浏览结果。
- 不再允许搜索引擎抓取受用户认证保护的页面。
- 当组织被删除时会重新验证缓存。
- 现采用 Scalar OpenAPI 解析器解析 OpenAPI 定义,提升性能、修复解析问题,并提供更清晰的错误信息。
- 现已支持在基于 OpenAPI 定义自动生成的 API 参考页中显示顶层描述。
- 为图标新增内联样式支持。
- 修复文档中自定义 CSS 的突兀弹入问题。
- 在与链接共存时,正确显示行内代码样式。
- 在浏览器中点击返回按钮时保留滚动位置。
September 2024
自定义字体

Card 组件中的图片
在 card 中添加img
属性,可在卡片顶部显示图片。了解更多信息请见此处。更新速度提升

SEO 改进

仪表盘改进
- 在仪表盘中完成 App Router 迁移。
- 仪表盘中现已提供搜索分析。
- 仪表盘中已新增删除组织功能。
- 上线了 GitLab 连接界面。
- 修复了错误的分析数据。
- 现在可直接通过仪表盘购买附加组件。
Bug 修复
- 修复了在自定义模式且侧边栏布局为
sidenav
时,顶栏不会拉伸至屏幕宽度的错误。 - 修复了 AI 小部件的相对定位问题。
更多
- API 页面故障排查:API 页面可能较为复杂,我们列出了常见问题,帮助你快速解决 — 阅读文档
August 2024
OpenAPI 参考页面
- 由 OpenAPI 定义且复杂、递归的端点现在体积缩小了 98%。
- 我们现在会在 OpenAPI 页面中展示 additionalProperties。
API 操作台中的文件上传
默认情况下,API 操作台请求由 Mintlify 代理。现在你可以使用disableProxy
禁用此行为,以支持文件上传等请求类型。移动端 SEO 改进
我们修复了文档的移动端布局,使其更符合 SEO 要求——包括为元素添加合适的 aria 标签。支持表单
我们在 Mintlify 仪表盘中新增了更详细的支持表单。你现在可以通过提交表单与我们联系。Bug 修复
- 修复了 Segment 集成功能的一个错误。
- 与编辑器交互时,我们现在会针对 GitHub 权限提供更细粒度的错误消息。
- 修复了使用直达链接时导航无法正确展开的错误。
July 2024
June 2024
发布周亮点
- 主题:使用预配置主题自定义样式。只需将 Quill、Prism 或 Venus 主题添加到你的
docs.json
文件中,文档样式会自动更新。 - Search V2:可直接检索 OpenAPI 端点的描述和标题以抵达 API Reference 页面,从搜索结果中移除隐藏页面,并体验我们升级后的搜索栏 UI。
- 网页编辑器分支:在我们的网页编辑器中创建分支,无需 IDE。
- 用户个性化:使用 Shared Session 或 JWT 对用户进行认证,以展示个性化内容,例如预填 API 密钥或为特定客户展示专属内容。
- OpenAPI 自动化升级:要自动填充 API 操作台页面,可在
docs.json
的 tabs 或 anchors 数组中的对象里添加一个openapi
字段。
April 2024
February 2024
质量改进
- 仪表盘升级:查看更新日志了解变更与更新状态,并在不同 Mintlify 项目间切换以管理部署
- 完整支持通过选项卡进行版本管理
- 支持通配符重定向
- CLI 错误检测:本地开发解析出错时,将显示无效 frontmatter 的位置
January 2024
发布周亮点
- 预览部署:当你创建 pull request 时,我们会生成一个唯一链接,展示你的文档在生产环境中的实时预览。你可以将该链接分享给队友。
- Snippets V2:现已支持可完全复用的组件和变量,用于片段。
- 开源 MDX 引擎:我们开放了两个 API——getCompiledMdx 和 MDXComponent——便于你使用 Mintlify 的 markdown 与代码语法高亮。欢迎为该项目贡献代码。
- AI Chat 洞察:可按日期分段聊天记录、在仪表盘中提升 AI Chat 配额,并查看特定查询的出现频率。