更新日志
创建包含基于日期条目、RSS 订阅支持和订阅者通知功能的产品更新日志,让用户及时了解最新动态。
在页面中添加 Update 组件,即可为你的文档创建更新日志。
查看 Mintlify 更新日志 作为示例:你可以在每次更新中包含指向新功能的链接、图片、文本和演示。
为更新日志创建页面
- 在文档中创建一个新页面,例如
changelog.mdx或updates.mdx。 - 将更新日志页面添加到
docs.json的导航配置中。
在更新日志中添加 Update 组件
为每条更新日志记录添加一个 Update。
包含相关信息,例如功能发布、错误修复或其他公告。
---
title: "更新日志"
description: "产品更新和公告"
---
<Update label="2025年3月" description="v0.0.10">
新增冬青薄荷口味。
绿薄荷口味发布新版本,薄荷含量提升10%。
</Update>
<Update label="2025年2月" description="v0.0.09">
绿薄荷口味发布新版本。
</Update>控制用户浏览更新日志的方式,并让他们及时掌握产品动态。
每个 Update 的 label 属性都会在右侧侧边栏的目录中自动创建一个条目。这是你的更新日志的默认导航方式。
在 Update 组件中添加 tags,即可将目录替换为标签筛选器。用户可以通过选择一个或多个标签来筛选更新日志。
当用户选择多个标签时,更新日志仅显示包含所有所选标签的更新。只要存在已激活的筛选器,更新日志就会隐藏没有标签的更新。
所选标签会以 ?tags= 查询参数的形式反映在页面 URL 中,因此用户可以分享指向筛选后更新日志视图的深层链接。打开像 /zh/changelog?tags=Spearmint 这样的链接会在加载时激活对应的侧边栏筛选器,更新筛选器时 URL 也会保持同步。使用逗号分隔多个标签,例如 /zh/changelog?tags=Spearmint,Peppermint。
<Update label="2025年3月" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
添加了新的 Wintergreen 口味。
发布了新版本的 Spearmint 口味,现在薄荷含量增加了 10%。
</Update>
<Update label="2025年2月" description="v0.0.09" tags={["Spearmint"]}>
发布了新版本的 Spearmint 口味。
</Update>
<Update label="2025年1月" 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 源会发布新的条目。
RSS 源条目只包含纯 Markdown,会排除组件、代码和 HTML 元素。当你的更新包含被排除的内容时,可以使用 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[Product updates]]></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[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
- 如 Readybot 或 RSS Feeds to Discord Bot 等 Discord 机器人
为便于发现 RSS 源,你可以在页面顶部显示一个链接到该源的 RSS icon 按钮。在页面 frontmatter 中添加 rss: true:
---
rss: true
---