新功能
- Products 导航:通过产品切换器导航来组织多产品文档
- 无障碍命令行界面(CLI)命令:运行
mint a11y
测试文档中的无障碍问题 - API 操作台中的视频响应:API 操作台现已支持显示视频响应类型
- API 操作台预填:新增预填 API 操作台示例的选项,加快测试速度
- 未认证反馈:对于使用部分认证的网站,用户现在无需认证即可提交反馈
- Shiki 主题支持:现已支持用于代码块样式的 Shiki 主题
- Twoslash 支持代码块:TypeScript 和 JavaScript 代码块现支持 Twoslash 内联类型信息
无障碍改进
- 在各组件中添加了全面的 ARIA 属性,以更好地支持屏幕阅读器
- 新增“跳至主内容”按钮,便于键盘导航
- 在 Tab 组件中支持方向键导航
- 增强了工具提示、嵌套列表和代码组的无障碍性
- 改进了全局 UI 的焦点状态和键盘交互模式
AI 助手与 Analytics 增强
- 为 AI 助手 query 分析新增柱状图可视化
- 在 AI 助手分析页面统一了日期范围选择器
- 为 AI 助手分析图表新增缩放控件
- 通过快捷键与聊天侧栏的改进,优化了 AI 助手历史记录管理
缺陷修复与可靠性
- 修复侧边面板遮罩的 z-index 问题
- 修复浅色模式颜色回退与主题相关样式错误
- 修复 API 操作台可展开项与锚点链接不兼容的问题
- 修复针对 ChatGPT 和其他 LLM 代理的
.md
链接可访问性 - 修复基于百分比的宽度与高度的图像尺寸处理
- 修复带语言标签与自定义主题的代码块渲染问题
- 修复折叠面板链接的格式与样式
- 修复当 AI 助手配置为空时底部区域的间距
- 修复本地存储库图像的卡片 icon 渲染
- 修复 API 操作台中的音频文件处理(防止 UTF-8 解码)
- 改进网页编辑器中的 PR 发布状态管理
语言支持扩展
- 在文档界面中新增对罗马尼亚语和捷克语的支持
- 增强本地化能力,完整覆盖新增语言的翻译
- 改进所有主题中的语言选择器功能
UI 与用户体验改进
- 修复 404 页面上的标签页可见性问题,防止错误的活动标签页高亮
- 增强图像处理,为非优化图像正确传递 width 和 height 属性
- 改进 404 页面的布局与样式一致性
基础设施与性能增强
- 通过跳过高成本的 Imgix 自动格式化增强 GIF 图像处理,减少处理时间与带宽占用
- 针对动图进行特殊处理以优化图像分发性能
缺陷修复与可靠性
- 修复控制台设置中 Assistant 增强功能请求的联系邮箱路由
- 增强数据库架构更新以改进用户管理
主要发布
- 重大增强:在 404 页面提供 AI 建议页面,当用户访问失效链接 → AI 代理读取路径 → 建议语义相似的页面
- 重大发布:AI 助手的网页搜索现在可以纳入外部来源
注意:如需为你的站点启用此功能,请联系我们。
AI 助手与 MCP
- 修复了因时间窗口未正确滑动,导致 AI 助手被错误地施加速率限制的问题
- 修复了助手工具调用在处理空
text
块时的错误 - 修复了 MCP 服务器名称与工具调用拼接后,有时会超过 MCP 客户端强制的 60 字符长度限制的问题
- 修复了助手菜单的 height 远大于视口并无限滚动的问题
- 修复了在控制台中助手花费数值可能显示超过两位小数的问题
Web 编辑器与部署
- 为编辑器新增安全增强:只有对已连接的 Git 托管存储库拥有
write permissions
的用户才能进行更改 - 修复了名称中包含
=
的 branch 无法进行预览部署的问题 - 修复了在创建预览部署时,过长的 branch 名称在弹窗中溢出的情况
- 体验优化:注册邀请中的 email query 参数现在会预填输入框
- 修复了在 Safari 上通过上下文菜单复制页面不起作用的问题
API 操作台与导航
- 多个 API 操作台响应码在获得焦点时,现以受控样式的选择菜单显示,而非系统默认的选择菜单
- 你现在可以在
docs.json
中的导航 groups 使用expanded
字段,使其默认展开
SEO 和 UI
- 修复了站点图标在搜索引擎中未显示的问题:现通过与各自文档站点相同的 URL 提供
- 修复了 YouTube 嵌入在加载时闪烁的问题
- 修复了将反馈菜单展开以包含文字回复时,导致与目录产生布局位移的问题
- 修复了在 Maple 主题中关闭通知横幅后,文本会溢出到顶部栏之上的问题
- 优化 Maple 和 Willow 主题:在侧边栏添加了登录/登出按钮,便于访问
Analytics 与导出
- 修复了助手 Analytics 视图和导出的可靠性问题
- 助手 Analytics 导出现在在后台执行,并通过电子邮件发送,提升稳定性与可靠性
重大版本发布:反馈收集增强
- 重大改进:读者在选择点赞/点踩后,现在可以提供更详细的反馈,包括选项和文字评论。你还可以对代码块收集反馈,并在控制台的 Analytics 中查看所有反馈。
注意:请联系我们为你的网站启用此功能。
导航与易用性改进
- 易用性改进:忽略末尾斜杠和双斜杠,这样你就无需在 docs.json 中把它们处理得一丝不苟
- 现在你可以在
h1-6
HTML 标签上添加noAnchor
属性,以避免生成锚点链接 - Palm 主题现在在左下角提供浮动语言选择器,类似 Stripe 的做法
- 在 docs.json 中新增名为
drilldown
的字段,可控制在展开某个导航分组时,是否将用户自动导航至该分组的第一页 - 易用性改进:使嵌套有序列表的样式在十进制/罗马数字与字母样式之间交替
Bug 修复与可靠性
- 修复了当页面存在 JS 组件时,滚动位置锚点链接无法正常工作的错误
- 修复了由于缺少
x-robots-tag noindex
头而导致 Google 将原始*.md
文件编入索引的问题 - 修复了受保护文档上的 OAuth 问题:成功完成流程后不会重定向回起始页面
- 修复了认证保护文档的预览中无法看到整个导航栏的问题
- 修复了使用我们新的图片 CDN 处理 SVG 的相关问题
组件与样式增强
- 为
SidebarNavGroupDivider
的自定义样式新增了一个 CSS 选择器 - 新增针对由 MDX 定义且配置了安全性的 API 页面之回归测试,以确保更高的稳定性
性能改进
- 通过将 KaTeX 的 CSS 从 cdnjs 迁移到我们在 CloudFront 上的自有 CDN,降低延迟、提升性能
图片处理改进
- 重大改进:即使未指定 width 和 height 属性,图片默认也不会造成布局位移——自动尺寸可防止页面加载期间的内容跳动
- 存储库中的所有静态文件(PDF、TXT、XML 等)现在会在部署时自动上传并提供服务,覆盖所有资源
Web 编辑器与部署增强
- 修复了 Web 编辑器中的 branch 创建流程,可正确跳转并停留在新创建的 branch 上
- 增强了合并冲突对话框的退出能力,无需再通过刷新页面来关闭冲突
- 优化更新流程性能:在部分更新时仅对变更页面进行缓存失效处理,从而缩短部署时间
认证与导航改进
- 新增对自定义子目录的认证支持;如果你在
https://yourdomain.com/docs
提供文档,认证现在可无缝工作 - 修复了仅配置一个链接时侧边栏仍会错误显示的问题
- 全面优化移动端导航:按钮居中并具有合适的外边距/内边距,改进下拉菜单的间距,移除空章节中不必要的分隔线和边距,并修复 Maple 主题的间距/内边距问题
组件与样式修复
- 解决了
<h1-6>
标签被错误转换为 Heading 组件从而破坏自定义样式的问题 - 在控制台中为 AI 助手新增一键配置开关,便于管理
技术改进与可靠性
- 增强了更新流程的日志系统,加快调试与问题解决
- 为拥有 10+ OpenAPI/AsyncAPI 规范的客户修复了 GitHub 速率限制问题:由逐个文件抓取改为存储库克隆
- 提升了 AI 助手的可靠性:增加后备 LLM 支持、强化限流错误处理,以及更稳健的搜索工具能力
性能与构建优化
- 在未缓存的 Next.js 无服务器环境中,MDX 转译现改为在部署时进行,而非每次页面加载时进行,从而缩短未缓存页面的首字节时间(TTFB)。
- 基于内容的哈希在 MDX 未发生变化时会阻止重新转译,将大量页面项目的更新流程时长降低约 50%(超过 5 分钟的部署应大致减半)
- 通过在后端添加数据库索引并对 query 并行化,控制台中的预览部署加载更快
- 通过移除每个页面
rsc
负载中重复的navigation
数据来减小页面体积——在页面数量多或导航结构复杂时收益最明显 - 更积极的预取使即时页面加载更常见
API 操作台和 OpenAPI 增强
- 将 OpenAPI 到 MCP 的转换迁移到后端,使托管的 MCP 服务器可包含工具(更清晰的文档和配置选项即将推出)
- 为 API 操作台新增 Ruby 支持
- 新增功能:现在你可以仅通过 docs.json 指定 API 页面,无需创建新的 mdx 文件。
- 在文档导航中支持来自 OpenAPI 规范的
webhook
页面 - 通过在导航至 Anthropic、OpenAI 或其他提供商时,从 Markdown 链接中移除锚点规格来优化 AI 模型上下文
Web 编辑器改进
- 创建/重命名文件时,点击空白处即可保存更改,无需再按 Enter 键
- 修复 branch 导航:将 URL 切换到特定 branch 时会错误地重定向到上次活动的 branch,而非目标分支
- 正确对包含
/
的 branch 标题进行 URL 编码,避免导航出错 - 修复 monorepo 控制台编辑器中的
Ctrl+K
插入链接快捷键此前会在前面附加 docs 仓库路径并导致链接失效的问题
Analytics 和 LLM 集成
- 支持自定义
llms.txt
和llms-full.txt
——将其添加到文档仓库根目录,即可通过/llms.txt
和/llms-full.txt
端点对 LLM 进行定制 - 新增 Hightouch 分析集成
- 增强对上下文菜单的分析跟踪(控制台视图即将上线)
- 为
llms.txt
和llms-full.txt
添加端到端测试,确保正确提供
组件与样式增强
- 支持在
h{1-4}
标签中使用自定义类名,以应用自定义标题样式 - 修复在自定义页面模式下,
h{1-4}
标签被渲染为带有徽章的Heading
组件的问题 - 为面包屑添加 CSS 选择器,便于定制化选择
- 通过分析尺寸以在 56px height 下保持比例,修复被拉伸的 open-graph 图像
- 在上下文菜单中将
VSCode
更正为VS Code
- 修复自定义组件内的标题与语义化标题一同出现在目录中的问题
错误修复与可靠性
- 通过清理导致生成问题的字符,修复某些页面标题的 PDF 渲染问题
- 解决在遇到空的 OpenAPI JSON 文件时出现的 CLI 错误
Cannot convert undefined or null to object
- 修复自定义
docs.json
open-graph 元标签被生成标签覆盖的问题 - 通过对 RSS 链接使用 origin + pathname,修复在锚点链接页面上 RSS 订阅按钮点击无效的问题
- 通过移除 sourcemaps 提升 CLI 下载速度
技术改进
- 在 CI 流水线中添加可视化测试,更早发现回归
- 增强错误处理与调试能力
- 为新功能和边界场景提供更完整的测试覆盖
认证改进
- 组级公开访问:通过
docs.json
将整个页面组设为公开,这样无需在每个页面上设置public: true
(了解更多) - 在 OAuth 配置中支持
logoutURL
,用于删除上游 Cookie 并完成登出 - 发生 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 工具形式暴露
AI 助手更新
- 修复了当新消息流式传入时,旧消息的操作菜单(包含复制、点赞等选项)会消失的问题
- 修复了上周 托管 MCP 服务器发布 后,嵌套的
/mcp/...
页面可访问性问题
性能与可靠性
- 文档仓库中的所有图片和视频资源现在都会在你的 domain 上以正确路径提供。例如,如果仓库中有
/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 中活动标签页未正确设置
- 修复了主题 light 背景色未应用于活动标签页 icon 的问题
- 修复了在控制台中更改认证类型会先更新后又回退到先前保存类型的问题——现在新选择在保存后会持久生效
- 面向拥有自定义 UI 库的企业客户的内部 DX 改进——我们更易在更短周期内纳入你的组件并响应需求
认证改进
- 优化本地环境中的认证流程,加速相关功能开发与缺陷修复
- 现已支持对受认证保护站点的预览部署
- 修复重定向行为,认证后可正确返回到原始页面
- 修复完整认证的登出按钮显示问题(之前仅在部分认证下可用)
API 操作台增强
- 修复 API 操作台中的
multipart/form-data
文件上传功能 - 修复锚点链接行为,点击后仅更新 URL 而不会滚动到页面顶部
- 修复嵌套选项卡中的锚点链接问题
AI 助手更新
- 新增 Assistant API,便于将其集成到你自己的产品中,兼容 AI SDK
- 为聊天回复新增复制按钮
- 修复在助手中重试消息的问题
- 改进默认助手提示词,使其默认更为简洁
性能与可靠性
- 通过在输入时中止防抖请求,让搜索更为灵敏且准确
- 为新的 CDN 预置资源——预计图像资源与页面加载时间将很快改善
- 修复渲染复杂 Mermaid 图表(如甘特图)的错误
- 修复 Windows 上的 CLI 问题以提升稳定性,并新增测试以防止回归
技术改进
- 在 Next.js 应用中加入 OpenTelemetry 追踪,以改善客户的首字节时间
- 从 Octokit 迁移到 GitHub API Client,提升网页编辑器的时延表现
- 修复 OpenGraph 的重复 meta 标签
- 将 MongoDB 从 6 升级到 7,带来更佳性能与新特性
Slack 应用
- 零摩擦访问:机器人可响应私信、@提及,以及你在
#ask-ai
频道中的任何提问 - 一键设置:可在数秒内直接从你的 Mintlify 控制台安装
- 具备上下文的回答:搜索你的全部文档以提供相关、准确的回复
- 减少支持打扰:将日常问题转化为即时、自助式答案
托管 MCP 服务器
通过 Mintlify 直接部署托管的 Model Context Protocol(MCP)服务器,以集成到 Claude、Cursor 等 AI 工具中。在我们的 MCP 指南中了解更多。通过上下文菜单,帮助用户从文档中的任意页面快速将你的 MCP 服务器连接到 Cursor 或 VS Code。参见上下文菜单了解更多信息。代码块改进
- 改进语法高亮
- 新增更多自定义选项,包括专注模式、可展开的代码块、深浅色模式自适应、语言下拉菜单、行号与图标
Web Editor 3.0

- 使用 ⌘ + P 快捷键按文件名搜索
- 页面加载速度提升至 10 倍
- 搜索 branch 时加载更快
- 页面选项 Tab 可配置布局、title 和用于 SEO(搜索引擎优化)的 metadata
- 选中文本时显示浮动工具栏
- 修复更新日志组件的上边距
- 提升右键操作的可靠性
- 点击发布后将停留在当前页面,而不会进入空白状态
- 统一文件 icon 的颜色
- 连续多次选择新 branch 后的稳定性提升
- 移除 Diff 模式
- 通过下拉菜单新建文件夹时行为更一致
- 修复尝试取消选择时引用块会继续生成更多引用块的问题
AI 翻译(测试版)

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

改进
- 为更新日志添加标签,便于终端用户筛选更新
- AI Chat 支持 Sonnet-3.7。可通过控制台配置你偏好的模型
- 可在控制台设置中直接修改部署名称
Bug 修复
- 修复 OG 图片
- 修复无容器锚点的 icon 样式不一致
- 改进控制台边框在移动/平板/桌面端的响应式样式细节
- 在 API 操作台的简洁模式下也显示代码示例
- Web 编辑器支持 “command + k” 搜索快捷键
- Callout 内的代码块会扩展以填满 callout 区域的 width
新的配置架构 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 组件:除 Tabs 和锚点外,还可使用下拉菜单组织导航。
- AI 语法修复器:网页编辑器会在出现解析错误时检测到,并使用 AI 提出修复建议。
November 2024
AI Writer

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

/llms.txt 支持

本地化
你现在可以对文档进行本地化,其工作方式与版本管理类似。为某个版本添加一个locale
后,Mintlify 中固定的内容(如 “Was this page helpful?”)也会匹配该 locale。质量改进
- 基于用户当前阅读的版本返回聊天与搜索结果
- 除了 JWT 或 Shared Session 令牌外,新增支持使用 OAuth 对用户进行身份验证
2024年10月
更新日志
推出全新的 Update 组件,让你更轻松地向用户展示与告知更新(就像这条一样)。
代码行高亮
你现在可以在文档中高亮代码行:在语言标识符后添加特殊注释即可突出重点。使用花括号{}
,并用逗号分隔指定的行号或范围。Line Highlighting Example
浅色模式代码块
代码块现在支持浅色模式,你可以在docs.json
中添加以下配置启用:高级页脚

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

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

SEO 改进

控制台改进
- 控制台完成 App Router 迁移。
- 控制台中现已提供搜索 Analytics。
- 控制台新增删除组织功能。
- 上线 GitLab 连接 UI。
- 修复了不正确的 Analytics 数据。
- 现在可以在控制台直接购买附加组件。
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
文件中,即可更新文档样式。 - 搜索 V2:可直接检索 OpenAPI 端点的说明和标题以跳转到 API 参考页面,从搜索结果中移除隐藏页面,并享受新版搜索栏 UI。
- Web 编辑器分支:无需 IDE,可在我们的 Web 编辑器中创建分支。
- 用户个性化:通过 Shared Session 或 JWT(JSON Web Token)进行用户认证,以便展示个性化内容,例如预填充 API key 或向特定客户展示专属内容。
- OpenAPI 自动化升级:为自动填充 API 操作台页面,可在
docs.json
的 tabs 或 anchors 数组中的对象里添加openapi
字段。
April 2024
February 2024
质量改进
- 控制台升级:查看更新日志以了解变更内容和状态,在不同 Mintlify 项目间切换以管理部署
- 完整支持使用 Tabs 进行版本管理
- 现已支持通配符重定向
- 命令行界面(CLI)错误检测:本地开发解析出错时,我们会显示无效 frontmatter 的位置
January 2024
发布周亮点
- 预览部署:当你创建拉取请求(PR;亦称“合并请求”/Merge Request)时,我们会生成一个唯一链接,展示文档在生产环境中的实时预览。你可以将该链接分享给队友。
- 片段 V2:现已支持可完全复用的组件与变量。
- 开源 MDX 引擎:我们开放了两个 API——getCompiledMdx 和 MDXComponent——便于你使用 Mintlify 的 Markdown 与代码语法高亮。欢迎为该项目贡献代码。
- AI 聊天洞察:按日期分段查看聊天历史、在控制台中提升 AI Chat 配额,并查看特定 query 的出现频率。