重要发布
- 重大增强:在 404 页面提供 AI 推荐页面,当用户点击失效链接 → AI 代理读取路径 → 推荐语义相似的页面
- 重大发布:AI 助手的网页搜索现可包含外部来源
注:如需为你的网站启用此功能,请联系我们。
AI 助手与 MCP
- 修复由于时间窗口未正确滑动而导致 AI 助手被错误限流的问题
- 修复 AI 助手工具调用,正确处理空的
text
块 - 修复 MCP 服务器名称与工具调用拼接后有时超过 MCP 客户端强制的 60 字符长度的问题
- 修复 AI 助手菜单高度远超视口并无限滚动的问题
- 修复控制台中 AI 助手花费值显示超过两位小数的问题
Web 编辑器与部署
- 为编辑器新增安全增强:仅允许对连接的 Git 托管存储库拥有
write permissions
的用户进行更改 - 修复预览部署在名称包含
=
的 branch 上无法工作的问题 - 修复较长 branch 名称在创建预览部署的模态框中溢出的问题
- 体验优化:在注册邀请中,email query 参数将预填输入框
- 修复在 Safari 中从上下文菜单复制页面不起作用的问题
API 操作台与导航
- 多个 API 操作台响应码现在在聚焦时显示为受控样式的选择菜单,而非系统默认选择菜单
- 你现在可以使用
docs.json
中导航 groups 的expanded
字段使其默认展开
SEO 与 UI
- 修复 favicon 在搜索引擎中不显示的问题,改为从与各文档站点相同的 URL 提供
- 修复 YouTube 嵌入在加载时闪烁的问题
- 修复展开反馈菜单以包含书面反馈时导致目录布局偏移的问题
- 修复在 Maple 主题中关闭通知横幅后文本会溢出到顶栏上方的问题
- 在 Maple 和 Willow 主题的侧边栏中新增登录/登出按钮,提升使用便捷性
Analytics 与导出
- 修复 AI 助手分析视图与导出的可靠性问题
- AI 助手分析导出现改为后台执行并通过电子邮件发送,提供更可靠的体验
重大发布:更强大的反馈收集
- 重大改进:读者在选择“点赞/点踩”后,现在可以提供更为详尽的反馈,包括选项与文字评论。你还可以对代码块收集反馈,并在控制台的 Analytics 中查看所有反馈。
注意:请联系我们为你的站点启用此功能。
导航与易用性改进
- 易用性优化:忽略结尾斜杠与双斜杠,你无需在 docs.json 中严格保证格式完全一致
- 现在可在
h1-6
HTML 标签上添加noAnchor
属性,避免生成锚点链接 - Palm 主题现于左下角提供浮动语言选择器,类似 Stripe 的做法
- 在 docs.json 中新增字段
drilldown
,用于控制当导航分组展开时,是否自动进入该分组的第一页 - 易用性优化:嵌套有序列表的样式将在十进制/罗马数字与字母之间交替
错误修复与可靠性
- 修复了页面存在 JS 组件时,滚动位置锚点链接工作不正确的问题
- 修复了因缺少
x-robots-tag noindex
头而导致 Google 将原始*.md
文件编入索引的问题 - 修复了受保护文档的 OAuth 问题:成功完成流程后不会重定向回起始页面
- 修复了受认证保护文档的预览中无法看到完整导航栏的问题
- 修复了使用新图片 CDN 处理 SVG 的相关问题
组件与样式增强
- 为
SidebarNavGroupDivider
新增用于自定义样式的 CSS 选择器 - 为在 MDX 中定义且含有安全设置的 API 页面新增回归测试,以确保更高稳定性
性能改进
- 将 KaTeX CSS 从 cdnjs 迁移到我们在 CloudFront 上的自有 CDN,以降低时延并提升性能
图像处理改进
- 重大改进:即使未指定 width 和 height 属性,图像默认也不会再造成布局位移——自动尺寸可防止页面加载过程中的内容跳动
- 存储库中的所有静态文件(PDF、TXT、XML 等)现会在部署时自动上传并提供服务,实现完整的资源覆盖
网页编辑器与部署增强
- 修复了网页编辑器中的 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
链接快捷键此前会在前面加上文档仓库路径并生成错误链接的问题
Analytics 与 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 height 下保持纵横比,修复被拉伸的 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 订阅按钮点击无效的问题
- 通过移除 source map 提升了命令行界面(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 图(如 GANTT 图)的问题
- 修复 Windows 上的 CLI 问题以提升稳定性,并新增测试防止回归
技术改进
- 在 NextJS 应用中加入 OpenTelemetry 追踪,以改善客户的首字节时间
- 从 Octokit 迁移到 GitHub API Client,以降低网页编辑器体验中的延迟
- 修复 OpenGraph 的重复 meta 标签
- 将 MongoDB 从版本 6 升级至 7,以获得更佳性能与新特性
Slack 应用
- 零摩擦访问:Bot 会响应私信、@提及,以及你在
#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 提出修复建议。
2024 年 11 月
AI Writer

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

/llms.txt 支持

本地化
你现在可以为文档添加本地化,工作方式与版本管理类似。为某个版本添加locale
后,Mintlify 中固定内容(例如 “此页面是否对你有帮助?”)也会匹配该 locale。质量改进
- 基于用户当前阅读的版本返回聊天与搜索结果
- 除了 JWT(JSON Web Token)或共享会话令牌外,现已支持使用 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 的出现频率。