更新日志

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

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

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

配置更新日志

1. 为更新日志创建页面

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

   为每条更新日志记录添加一个 Update。

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

Example changelog.mdx

---
title: "Changelog"
description: "Product updates and announcements"
---
<Update label="March 2025" description="v0.0.10">
  Added a new Wintergreen flavor.

  Released a new version of the Spearmint flavor, now with 10% more mint.
</Update>

<Update label="February 2025" description="v0.0.09">
  Released a new version of the Spearmint flavor.
</Update>

自定义你的更新日志

控制用户浏览更新日志的方式，帮助他们及时了解你的产品动态。

目录

每个 Update 的 label 属性都会在右侧边栏的目录中自动创建一个条目。这是你的更新日志的默认导航方式。

标签筛选

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

Tag filters example

<Update label="March 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
  Added a new Wintergreen flavor.

  Released a new version of the Spearmint flavor, now with 10% more mint.
</Update>

<Update label="February 2025" description="v0.0.09" tags={["Spearmint"]}>
  Released a new version of the Spearmint flavor.
</Update>

<Update label="January 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
  Deprecated the Peppermint flavor.

  Released a new version of the Spearmint flavor.
</Update>

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

可订阅的更新日志

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

当发布新的 Update 组件，或在已有的 <Update> 标签中新增标题时，RSS 源会自动加入对应条目。

Update 组件的一级标题会作为 RSS 条目的标题，且这些条目会链接到文档中相应标题的锚点。

Example RSS feed

<?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[Product updates]]></title>
    <description><![CDATA[New updates and improvements]]></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[June 2025]]></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 的 Email
• Discord 机器人，如 Readybot 或 RSS Feeds to Discord Bot

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

---
rss: true
---