Jamdesk Documentation logo

更新日志

了解 Jamdesk 的最新功能、CLI 更新与平台变更,涵盖 MDX、GitHub 和 API 文档。

Get Jamdesk release notes

New features and platform changes, straight to your inbox.

Jamdesk 可将您的文档翻译成 27 种语言。Settings → Translations 中勾选所需语言,每个项目最多选择五种。每次构建后,翻译页面都会提交到您的 GitHub 仓库。后续构建只会重新翻译英文源文件发生变化的页面。您已有的翻译或手动编辑过的翻译会一直保留,直到您点击 Replace with AI translation。所有套餐均包含此功能。AI 翻译 →

自定义文档 URL。 子路径托管不再绑定到 /docs。在 Custom Domain 卡片的子路径字段中输入单个路径段,例如 helpguide,然后保存。/docs 会继续提供服务,规范 URL 会立即迁移到新路径;之前的自定义子路径会在一次重命名期间重定向到新路径,因此您可以按自己的节奏更新代理配置。子路径托管 →

更快速地使用 AI 修复问题。 从构建横幅打开修复预览时,现在完成速度更快,大型网站也不例外;重新打开几乎可以即时完成,因为 Jamdesk 会保留扫描结果,直到您的文档发生变化。流程不变:查看每项建议的编辑,应用您批准的修改,Jamdesk 会提交这些修改并重新构建。使用 AI 修复 →

第四个主题:Halo。docs.json 中设置 "theme": "halo",即可获得温暖、圆润的外观:使用 Figtree 字体、带有卡片式内容区域的沙色背景,以及所有内置主题中最大的圆角。在 Jam、Nebula 和 Pulsar 中可用的自定义颜色、字体和 CSS 覆盖,在此主题中也以相同方式工作。主题设置 →

仅从您自己的域名提供文档。 在 Custom Domain 卡片中启用 Custom domain only 后,直接访问 YOUR_SLUG.jamdesk.app 会返回 404,而您的 CNAME 或代理仍可正常工作。Jamdesk 会在切换启用状态前检查您的线上域名;如果 DNS 出现故障,子域名会重新提供服务,直到域名恢复。此设置会对直接访问者隐藏子域名,但不会控制谁可以阅读您的文档;如需限制访问,请同时使用密码保护。仅限自定义域名 →

从规范构建完整的 API 参考。 使用 "openapi": { "source": "/openapi/api.yaml", "generate": true } 将导航标签指向您的 OpenAPI 文件,每次构建都会为每个操作创建一个页面,并按标签在侧边栏中分组。已提交的端点页面会保留其 slug,因此您可以逐页迁移;重命名后的路径会从旧 URL 重定向,而不是返回 404。生成的 API 页面 →

让读者选择要查看的 API 服务器。 如果规范列出了多个 servers 条目,端点 URL 旁边会显示选择器。选择 sandbox 后,基础 URL、复制按钮、每个代码示例以及 playground 发送的请求都会切换,因此读者不会从 sandbox 文档中复制生产环境的 curl 命令。只有一个服务器的端点不受影响。API Playground →

Markdown 可在所有 OpenAPI 描述中渲染。 表格、列表、链接、code粗体 在参数、请求正文、响应和架构描述中的渲染方式,现在与操作描述一致。过去有九个位置的表现不一致,现在全部共享同一个渲染器。OpenAPI 示例 →

端点 Markdown 导出包含身份验证信息。 获取 API 参考页面的 .md 版本后,文件末尾会有一个 ## Authentication 部分,列出操作所需的方案:类型、标头名称、bearer 格式、OAuth 2 作用域,以及哪些组合有效。读取导出的代理无需打开您的规范,即可构建可用的请求。Markdown 源文件 →

让页面不出现在搜索中,但不隐藏页面。 在页面的 frontmatter 中添加 search: false,即可将其从站内搜索、AI 聊天答案和 MCP 服务器中移除,同时保留在侧边栏、站点地图和 llms.txt 中。适合用于您仍希望可以链接和编入索引的过时页面。隐藏页面和 noindex 页面也会被阻止出现在 AI 答案中,而此前并非如此。仅将页面移出搜索 →

jamdesk validate 会警告无效配置。 某些 docs.json 键虽然会被接受,却从未实际渲染,其中最典型的是 asyncapi;因此配置看似受支持,构建网站后却什么也看不到。该命令现在会列出这些键,以及第一个 api.mdx.server 条目之后的额外条目,这些条目一直都会被丢弃。CLI 概览 →

直接在仪表板中编辑文档。 Web 编辑器现已面向所有用户开放,无需设置。在侧边栏中打开 Editor,浏览已连接的仓库,编辑带有实时预览的 MDX,并直接提交到您的 GitHub 分支,同时自动触发构建。Web 编辑器 →

在仪表板中使用 AI 修复构建警告。 当构建因链接损坏或页面缺少描述而完成时,构建页面现在会显示 Fix with AI 横幅,并列出可以修复的问题数量。打开横幅即可预览每项建议的编辑(重写的锚点和建议的页面描述),然后应用您批准的修改。Jamdesk 会将修改提交到您的 GitHub 分支并启动新的构建。无法明确解决的问题会单独列出,供您手动修复。使用 AI 修复 →

无限团队成员。 现在所有项目的所有套餐都包含无限团队成员,不收取额外费用。原先的 10 人上限和按席位计费已取消——邀请整个团队即可。

让受信任的机器人发布文档。 Dependabot、Renovate 或 CMS 发布机器人等自动化账户不是 Jamdesk 成员,因此默认情况下,它们的推送不会触发构建。现在,当此类推送被拒绝时,构建页面会显示一个一键式 Authorize Bot Account 按钮。批准后,该账户的推送就会发布到您的线上网站,与团队成员的推送一样。只有项目成员可以授权账户;您可以随时在项目 GitHub 设置的 Allowed automation accounts 下查看或撤销访问权限。

每次构建都会为您的文档生成 AI Score。 Jamdesk 现在会根据开放的 AFDocs 标准,在每次构建后自动评估 AI 代理读取已发布文档的效果,并直接在仪表板中显示结果。查看 0–100 分和字母等级,跟踪多次构建之间的趋势,并为每个问题获取通俗易懂的修复建议;每条建议都有 Copy prompt to fix 按钮,可将发现的问题交给您的 AI 编码代理。启用 Email team when score changes 后,当构建导致分数发生明显变化时,您会收到通知。AI Score →

自动修复损坏的链接。 对于目标明确的内部链接损坏警告(例如拼写错误的锚点和跨语言锚点偏移),现在可以使用一个命令修复。运行 jamdesk fix --dry-run 预览计划中的更改,然后运行 jamdesk fix 应用更改;只有能解析到真实标题的正确锚点才会被修改,存在歧义的情况会留待手动检查。CLI 概览 →

使用横幅发布任何消息。docs.json 中添加 banner,消息栏就会固定在每个页面顶部,位于页眉上方,并使用主题的强调色。可以使用链接、粗体斜体内联格式;设置 dismissible: true 后,读者会看到关闭按钮(除非您更改消息,否则横幅会保持关闭状态)。横幅 →

显示每个页面的最后更新时间。docs.json 中设置 metadata.timestamp: true,每个页面的页脚都会显示类似“Last updated on June 15, 2026”的文本。日期来自最后一次修改该页面的 Git 提交,因此每次构建都会保持准确,无需手动维护日期。页面元数据 →

设置导航图标样式。 侧边栏、分组、标签、锚点和搜索图标现在会遵循图标对象中的 style{ "name": "rocket", "style": "duotone" })或样式前缀(duotone/rocket),支持 light、thin、duotone 和 sharp 系列,而不仅是 solid。图标 →

自定义搜索栏。 使用 search.prompt 设置自己的占位文本,并通过 search.popularPages 管理访客在空搜索面板中看到的快速链接;每个链接包含标题、页面 slug 和 Font Awesome 图标。搜索配置 →

无需嵌入代码即可收集邮箱注册。Integrations → Email Signups 中连接 Resend、Mailchimp、Kit、Loops、beehiiv、Brevo 或 SendGrid,Jamdesk 托管的表单就会将读者直接添加到您自己的受众列表中——API 密钥会保留在我们的后端,绝不会出现在已发布的网站中。将 EmailSubscribe 组件添加到任意页面,或设置 placement: changelog,自动在每个更新日志页面中放置注册框。邮箱注册 →

在 Cookie 同意后再启用分析。docs.json 中添加 integrations.cookies 键,Jamdesk 会暂停所有分析和跟踪脚本——包括 Google Analytics、GTM、Plausible、Crisp、自定义 JavaScript 以及内置分析——直到访客同意;同意状态从您的同意横幅设置的 localStorage 标志中读取。也可以直接从 docs.json 加载 Osano 或 Termly 横幅;简短的桥接代码片段会在读者接受时立即切换标志,脚本无需重新加载页面即可运行。Cookie 同意 →

结构化的 llms.txt。 每个网站的 llms.txt 现在都遵循 llmstxt.org 结构——导航标签和分组会成为 ## 部分,让 AI 代理按照侧边栏的组织方式查看文档。多语言网站每种语言都有一个索引:根文件列出默认语言,并链接到每个翻译索引(例如 /fr/llms.txt),使每个文件保持足够小,避免被代理截断。llms.txt →

让代理更快找到文档。 每个页面现在都包含一条不可见且屏幕阅读器不会朗读的指令,引导 AI 代理访问 llms.txt 和页面的 .md 版本;每个 Markdown 导出文件开头也会有一个链接到索引的引用块。获取 HTML 的代理不再需要猜测 Markdown 路径的存在。AI 概览 →

在任何位置嵌入更新日志。 只需一个 <script> 标签,即可将“What's new?”启动器嵌入您自己的应用,并在模态框中打开 Jamdesk 更新日志,同时为每位访客显示未读圆点。从 Integrations → What's New widget 生成代码片段,然后使用 data- 属性调整启动器模式、角落位置、模态框大小和圆点颜色。在您自己的 Jamdesk 文档中,<Widget> MDX 组件只需一个标签、无需脚本,就能将相同的实时启动器添加到任意页面。嵌入更新日志 →

将 API 规范下载为 zip。 在任意 API 参考页面中,AI Actions 菜单现在提供 Download API spec 选项,可将网站引用的所有 OpenAPI 规范(包括本地文件和远程 URL)打包为单个 api-specs.zip。多文件规范会保留其 $ref 文件夹结构,因此下载内容可以直接导入 Postman、客户端生成器或您自己的工具。AI Actions →

在构建时验证 OpenAPI 规范。 每次部署现在都会严格验证 docs.json 引用的 OpenAPI 规范,并将任何问题显示为非致命构建警告,而不是让构建失败。文档仍会发布;您只会通过邮件和仪表板的构建列表获知具体问题,例如 YAML 解析错误及其行列号、无法解析的 $ref 或重复的 operationId。在本地,jamdesk dev 仍会因无效规范而停止,以便您在推送前发现问题。CLI 概览 →

直接从搜索中询问 AI。 在搜索框中开始输入,然后将问题交给 AI 聊天,而不是打开搜索结果——按 ⌘/Ctrl+Enter,或点击搜索页脚中的 Ask AI。问题会追加到聊天对话中,您可以继续当前话题;直接按 Enter 仍会跳转到第一个结果。AI 聊天 →

复制答案和对话记录。 每条 AI 聊天回答都有一个复制按钮,可获取 Markdown 源文件;聊天页眉中的 Copy transcript 操作则会将完整对话复制为带角色标记的 Markdown,方便粘贴到 issue 或文档中。AI 聊天 →

更智能的聊天自动滚动。 只有当您已经位于底部时,聊天才会跟随流式回答。向上滚动重新阅读较早的回复时,页面会保持当前位置,不会强行将您拉到底部;滚回底部后,页面会重新固定在那里。

本地预览支持自定义 CSS(CLI)。 jamdesk dev 现在会像已发布的构建一样应用自定义 CSS,因此您可以在部署前检查样式。将任意 .css 文件放入项目根目录——例如 style.css,或多个按字母顺序合并的文件——浏览器刷新时就会加载。无需在 docs.json 中添加条目,与 Mintlify 引入根目录样式表的方式一致。自定义 CSS →

从 frontmatter 自定义社交预览。 直接在页面的 frontmatter 中设置任意 Open Graph 或 Twitter/X 元标签,包括 og:titleog:descriptionog:imagetwitter:cardkeywords 以及完整的元标签集合。可以使用扁平的顶层键,也可以使用嵌套的 seo: 块;两种方式都有效,页面级值会覆盖 docs.json 中的默认值。SEO →

隐藏页面。 无需删除草稿、内部手册或已弃用指南,即可将它们从侧边栏和搜索结果中移除。在页面 frontmatter 中添加 hidden: true,或在 docs.json 的分组或标签中添加该设置。隐藏页面仍可通过直接 URL 访问,但会从导航、站点地图、站内搜索和 AI 上下文中消失,并自动添加 noindex 标签。如果需要隐藏分组,但仍希望其中的页面出现在搜索排名中,请同时添加 searchable: true隐藏页面 →

网格和窗口装饰。 两种新的背景图案加入了 Jam 主题的渐变默认背景。将 background.decoration 设置为 "grid",即可使用细微的 24px 点阵网格;设置为 "windows",则会在上方两个角落显示 Windows 11 风格的磨砂光斑。渐变和 "none" 平面填充仍按原方式工作——选择适合您品牌的外观即可。背景 →

自定义背景。 docs.json 中新增的 background 块可以停用 Jam 浅色模式渐变、按模式覆盖页面颜色,或调整渐变的颜色、大小、位置和不透明度。无需自定义 CSS。背景 →

D2 图表。 Mermaid 之外现在支持第二种图表语言。将围栏代码块标记为 d2,Jamdesk 就会在构建时将其渲染为 SVG,并内置浅色和深色主题。工作流程与 Mermaid 相同——选择适合您所绘制图表的语言即可。D2 图表 →

分组搜索结果。 搜索不再因同一页面匹配多个部分而重复显示该页面。搜索命中项会在搜索模态框中归入其父页面下,默认显示最多三个部分,其余部分可通过内联展开器查看。摘要高亮会保留,您可以用更少的扫描次数找到正确部分。

连接时自动检测 docs.json 连接 GitHub 仓库时,无论 docs.json 位于何处,系统都能找到它。连接流程会扫描整个目录树;如果发现 Mintlify 的 mint.json,还会将其标记出来。单仓库和嵌套配置无需手动设置即可使用。连接 GitHub →

CLI 中显示 docs.json 位置提示。 错误放置的配置现在更容易发现。jamdesk validatejamdesk devjamdesk doctor 会报告 docs.json 实际所在的位置,或应放置的位置,而不是只显示笼统的“未找到”错误。无需解读堆栈跟踪,几秒内即可修复。CLI 概览 →

符合标准的 hreflang。 hreflang 标签现在会输出有效的 BCP 47 代码。cnjpja-jp 等区域文件夹会映射到搜索引擎实际需要的代码(zhja),站点地图 URL 也会进行 XML 转义。每个本地化页面都会在自己的区域获得排名,而不会被视为重复内容。语言 →

PDF 导出。 在仪表板的 Settings → PDF Exports 中,将整个文档网站渲染为单个 PDF。仅限付费套餐。多语言项目可以为每次导出选择区域设置,结果会按提交缓存;渲染完成后,您会收到包含下载链接的邮件。

多语言 OpenAPI 规范。 端点页面现在会在翻译后的 MDX 旁边渲染翻译后的 OpenAPI 规范。将 <spec>.<lang>.<ext> 文件(例如 openapi/api.fr.yaml)放在源规范旁边,Jamdesk 就会在对应语言的 URL 中使用它;如果缺少某种语言的版本,则回退到英文规范。操作摘要、参数描述、响应描述和架构描述都会进行本地化。设置方法:翻译 OpenAPI 规范

Visibility 组件。 新的 <Visibility for="humans|agents"> 组件可让您在同一页面中为人类读者或 AI 代理划分内容。仅供人类阅读的区块会在浏览器中渲染,但会从 .md 导出文件和 llms-full.txt 中移除;仅供代理使用的区块则相反。代理通过规范 URL 请求 Accept: text/markdown 时,会自动获得代理视图。

密码保护,全面升级。 您可以用共享密码锁定整个网站,也可以只保护少数页面,同时让其余页面保持公开。设置 auth.password.enabled: true 可启用全站模式;或者在页面 frontmatter 中标记 private: true,或将页面列在 auth.password.private 下,以启用指定页面模式。仪表板的 Settings 页面会引导您设置、轮换和撤销密码。访客会看到带有网站徽标、主色和您在 docs.json 中定义的可选提示的品牌解锁页面。设置指南:密码保护

自动转换 WebP 图片。 Jamdesk 可以在构建时将 PNG 和 JPG 图片转换为 WebP。转换后的文件通常比原始文件小 60–80%,且没有明显的质量损失,因此无需手动处理图片即可加快页面加载。通过 docs.json 中的 images.convertToWebp: true 启用。为兼容社交平台爬虫,favicon、og:imagetwitter:image 会保留原始格式。新的 Optimizing images 步骤会在每次构建期间于仪表板和 CLI 中显示实时进度。自动图片转换 →

API Playground。 端点页面现在包含交互式 "Try it" 按钮。填写参数,实时查看代码示例更新,并且无需离开文档即可发送实时请求。默认对所有 API 页面启用,同时适用于 OpenAPI 和使用 MDX 编写的端点。

Claude Code 插件。 安装 Jamdesk 的 Claude Code 插件,让 Claude 深入了解 MDX 组件、docs.json 配置、导航模式和 CLI 命令。只需从插件市场完成两步安装。该插件可与 CLAUDE.mdMCP 服务器 配合,用于 AI 辅助编写文档。

缺少品牌资源时显示构建警告。 如果 docs.json 中的 faviconlogo 路径指向项目中不存在的文件,构建现在会发出警告。警告会显示在仪表板的构建详情中,也会通过 jamdesk devjamdesk validate 显示在 CLI 中。不发送邮件;该警告仅供参考。

YouTube Shorts。 <YouTube> 组件 通过 short 属性支持竖屏 Shorts,渲染居中的 9:16 播放器且不显示黑边。使用 <YouTube id="VIDEO_ID" short />

AI Actions 菜单。 每个页面上的 下拉菜单都允许读者复制 Markdown、在 ChatGPT/Claude/Perplexity 中打开页面、获取 MCP 服务器配置,或一键在 Cursor 或 VS Code 中安装。默认启用;通过 docs.json 中的 contextual 选择显示哪些选项。

分析。 无需 Cookie 即可跟踪页面浏览量、流量来源和访客趋势,并提供按页面的细分数据。无需同意横幅。概览:分析

集成。 Google Analytics 4Google Tag ManagerPlausible AnalyticsSlack 构建通知(Pro)。

更新日志 RSS Feed。 frontmatter 中包含 rss: true 的页面现在会自动生成可订阅的 RSS Feed。页面标题旁会显示 RSS 图标,并且每次构建都会根据您的 Update 组件生成 feed.xml。在 Update 中使用新的 date 属性以提供正确的 Feed 日期。

CLI 登录与部署。 jamdesk login 通过浏览器完成身份验证。jamdesk deploy 会打包项目,并从终端触发构建。无需连接 GitHub。CLI 遵循 .gitignore,会警告包含机密信息的文件,并在终端内实时输出构建进度。

CLI 拼写检查。 jamdesk spellcheck 使用 180 多个内置技术术语检查文档中的拼写错误(仅限英文)。jamdesk spellcheck --fix 会启动交互模式,用于修复拼写错误或将词语添加到忽略列表。

视频嵌入。 可直接在文档中嵌入 .mp4.webm 文件。将视频放入 /videos 目录,然后使用 Markdown 语法(<Video src="/_jd/videos/demo.mp4?v=mtw5936s" title="Demo" />)或 <Video> 组件 来控制自动播放、循环播放和其他选项。

自定义 JavaScript。 通过 docs.json 中的 styling.js 添加客户端脚本,用于聊天组件、分析或第三方集成。

AI 聊天。 每个文档网站都内置聊天助手。访客可以提问,并获得带有指向源页面引用链接的答案。由 Claude 提供支持,所有套餐均可启用。

AI 集成。 每个网站都会生成用于 LLM 上下文窗口的 llms.txt,通过 .md URL 提供原始 Markdown,并在 /_mcp 提供带有 searchDocsgetPage 工具的 MCP 服务器。提供 Claude CodeCursorCodex 的设置指南。另外还有:使用 AI 编写自动更新

CLI。 使用 jamdesk dev 进行支持热重载的本地预览,使用 jamdesk validate 检查损坏的链接,使用 jamdesk migrate 从 Mintlify/GitBook/Docusaurus 迁移,使用 jamdesk doctor 排查设置问题。可通过 npm、curl 或 Homebrew 安装。完整参考 →

VS Code 扩展。 从 VS Code 状态栏启动、停止和重启开发服务器,无需使用终端。

自定义域名 TXT 验证。 所有自定义域名现在都需要 TXT 记录(_jamdesk.yourdomain.com),路由才会启用。这可以防止未认领子域名遭到域名接管。新添加的域名会在仪表板设置流程中显示 TXT 记录。请参阅自定义域名指南

多语言支持。 为每个区域设置定义单独的导航树和内容目录。读者可以从顶部栏的下拉菜单切换语言。

搜索分析。 查看读者搜索的内容、哪些查询没有返回结果,以及哪些结果实际获得了点击。这有助于发现内容缺口。

Jamdesk 正式上线。使用 MDX 编写文档,推送到 GitHub,即可在全球 CDN 上获得网站。构建在 60 秒内完成。

MDX 与组件。 提供 20 多个内置组件:标签页、折叠面板、步骤、代码组、Mermaid 图表、KaTeX 数学公式和图标。在代码块中使用带行号的语法高亮。使用 Tailwind 和 hooks 构建自定义 React 组件,并通过代码片段复用内容。组件概览 →

OpenAPI 文档。 通过 docs.json 中的 api.openapi,根据 OpenAPI 规范生成 API 参考页面

部署。 推送后从 GitHub 自动部署,延迟 10 秒。支持带自动 SSL 的自定义域名、位于 /docs子路径托管(Vercel、CloudFront、Cloudflare、nginx)以及单仓库支持

自定义。 提供三个主题jamnebulapulsar),支持自定义颜色、徽标和页脚。使用自定义 CSS覆盖样式。支持带标签、分组和图标的灵活导航重定向支持精确匹配和通配符匹配。

搜索与 SEO。 开箱即用的 Cmd+K 全文搜索,无需配置。内置站点地图、OG 图片和页面级元数据

docs.json 参考 涵盖所有设置和选项的完整配置参考。

帮助中心 提供账户管理、账单和故障排除指南。


保持更新

Jamdesk 博客

详细公告和教程

GitHub Releases

CLI 发布说明