> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-add-hello-world-quickstart-48843.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 变更日志

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

在页面中添加[更新组件](/zh/components/update)，即可为你的文档创建变更日志。

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

<div id="setting-up-your-changelog">
  ## 设置变更日志
</div>

<Steps>
  <Step title="创建变更日志页面">
    1. 在文档中创建一个新页面，例如 `changelog.mdx` 或 `updates.mdx`。
    2. 将变更日志页面添加到 `docs.json` 中的导航结构。
  </Step>

  <Step title="在变更日志中添加 Update 组件">
    为每条变更记录添加一个 `Update`。

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

```mdx 示例 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>
```

<div id="customizing-your-changelog">
  ## 自定义变更日志
</div>

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

<div id="table-of-contents">
  ### 目录
</div>

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

<Frame>
  <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/K9uomxeMDdJnUp_m/images/changelog-toc-light.png?fit=max&auto=format&n=K9uomxeMDdJnUp_m&q=85&s=95a8e0d0cbbe0abbc59270dba19b0b2c" alt="浅色模式下显示目录的变更日志。" className="block dark:hidden" width="2632" height="1502" data-path="images/changelog-toc-light.png" />

  <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/K9uomxeMDdJnUp_m/images/changelog-toc-dark.png?fit=max&auto=format&n=K9uomxeMDdJnUp_m&q=85&s=69c8a77ab966221c7bb8020a95a54fd0" alt="深色模式下显示目录的变更日志。" className="hidden dark:block" width="2590" height="1432" data-path="images/changelog-toc-dark.png" />
</Frame>

<div id="tag-filters">
  ### 标签筛选
</div>

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

```mdx 标签筛选示例包裹
<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>
```

<Frame>
  <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/K9uomxeMDdJnUp_m/images/changelog-filters-light.png?fit=max&auto=format&n=K9uomxeMDdJnUp_m&q=85&s=178e1f3c02f9deef9bad12ddb97376ff" alt="浅色模式下的变更日志，已选择 Peppermint 标签筛选。" className="block dark:hidden" width="2170" height="582" data-path="images/changelog-filters-light.png" />

  <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/K9uomxeMDdJnUp_m/images/changelog-filters-dark.png?fit=max&auto=format&n=K9uomxeMDdJnUp_m&q=85&s=bb16954a05f01ea8aebc141ff477fe8a" alt="深色模式下的变更日志，已选择 Peppermint 标签筛选。" className="hidden dark:block" width="2172" height="584" data-path="images/changelog-filters-dark.png" />
</Frame>

<Tip>
  使用 `custom`、`center` 或 `wide` 页面模式时，目录与变更日志筛选器会被隐藏。了解更多[页面模式](/zh/pages#page-mode)。
</Tip>

<div id="subscribable-changelogs">
  ### 可订阅的变更日志
</div>

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

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

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

```xml 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](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack)
* 通过 Zapier 的[邮件](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email)
* 如 [Readybot](https://readybot.io) 或 [RSS Feeds to Discord Bot](https://rss.app/en/bots/rssfeeds-discord-bot) 等 Discord 机器人

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

```mdx
---
rss: true
---
```

<Frame>
  <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/K9uomxeMDdJnUp_m/images/changelog-rss-button-light.png?fit=max&auto=format&n=K9uomxeMDdJnUp_m&q=85&s=c9c022f33f707e13d9513fc2355240b7" alt="浅色模式下的变更日志页面，RSS 订阅按钮已启用。" className="block dark:hidden" width="1486" height="388" data-path="images/changelog-rss-button-light.png" />

  <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/K9uomxeMDdJnUp_m/images/changelog-rss-button-dark.png?fit=max&auto=format&n=K9uomxeMDdJnUp_m&q=85&s=f2bad6860a9f217d3b0d019546f8f73d" alt="深色模式下的变更日志页面，RSS 订阅按钮已启用。" className="hidden dark:block" width="1486" height="388" data-path="images/changelog-rss-button-dark.png" />
</Frame>