变更日志

在文档中发布产品更新，并提供可订阅的 RSS 订阅源

在页面中添加更新组件，即可为你的文档创建变更日志。

可参考 Mintlify 变更日志 示例：每次更新中你可以包含链接、图片、文本，以及新功能演示。

​

设置变更日志

1. 创建变更日志页面

   1. 在文档中创建一个新页面，例如 changelog.mdx 或 updates.mdx。
   2. 将变更日志页面添加到 docs.json 中的导航结构。
2. 在变更日志中添加 Update 组件

   为每条变更记录添加一个 Update。

   包含相关信息，例如功能发布、错误修复或其他公告。

示例 changelog.mdx

---
title: "更新日志"
description: "产品更新与公告"
---
<Update label="2025年3月" description="v0.0.10">
  新增 Wintergreen 口味。

  发布了 Spearmint 口味的新版本，薄荷含量提升 10%。
</Update>

<Update label="2025年2月" description="v0.0.09">
  发布了 Spearmint 口味的新版本。
</Update>

​

自定义变更日志

控制用户如何浏览你的变更日志，并及时获取产品更新信息。

​

目录

每个 Update 的 label 属性都会在右侧边栏的目录中自动生成一项。这是变更日志的默认导航方式。

​

标签筛选

在 Update 组件中添加 tags，可以用标签筛选替代目录。用户可以通过选择一个或多个标签来筛选变更日志：

标签筛选示例包裹

<Update label="March 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
  新增 Wintergreen 口味。

  发布 Spearmint 口味的新版本，薄荷含量提升 10%。
</Update>

<Update label="February 2025" description="v0.0.09" tags={["Spearmint"]}>
  发布 Spearmint 口味的新版本。
</Update>

<Update label="January 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
  宣布停用 Peppermint 口味。

  发布 Spearmint 口味的新版本。
</Update>

使用 custom、center 或 wide 页面模式时，目录与变更日志筛选器会被隐藏。了解更多页面模式。

​

可订阅的变更日志

使用 Update 组件会在你的页面 URL 后追加 /rss.xml，并创建一个可订阅的 RSS 源。例如：mintlify.com/docs/changelog/rss.xml。

当发布新的 Update 组件，或在现有的 <Update> 标签内新增标题时，RSS 源中会添加相应条目。

Update 组件的一级标题将用作 RSS 条目的标题，且条目会链接到文档中对应标题的锚点。

RSS 订阅源示例

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
  <channel>
    <title><![CDATA[产品更新]]></title>
    <description><![CDATA[最新更新与改进]]></description>
    <link>https://mintlify.com/docs</link>
    <generator>RSS for Node</generator>
    <lastBuildDate>Mon, 21 Jul 2025 21:21:47 GMT</lastBuildDate>
    <atom:link href="https://mintlify.com/docs/changelog/rss.xml" rel="self" type="application/rss+xml"/>
    <copyright><![CDATA[Mintlify]]></copyright>
    <docs>https://mintlify.com/docs</docs>
    <item>
      <title><![CDATA[2025 年 6 月]]></title>
      <link>https://mintlify.com/docs/changelog#june-2025</link>
      <guid isPermaLink="true">https://mintlify.com/docs/changelog#june-2025</guid>
      <pubDate>Mon, 23 Jun 2025 16:54:22 GMT</pubDate>
    </item>
  </channel>
</rss>

RSS 源可以与 Slack、邮件或其他订阅工具集成，用于通知用户产品更新。可选项包括：

• Slack
• 通过 Zapier 的邮件
• 如 Readybot 或 RSS Feeds to Discord Bot 等 Discord 机器人

为便于发现 RSS 源，你可以在页面顶部显示一个指向该源的 RSS 图标按钮。在页面的 frontmatter 中添加 rss: true：

---
rss: true
---