更新

Update 组件用于创建时间线式的更新日志条目。条目会显示在目录中。每个条目可以包含日期标签、描述和分类标签。可用于"新功能"页面、API 更新日志和发布说明。

在以下情况使用 Update：

• 记录发布版本，包含版本号或日期
• 构建更新日志，让读者可通过目录导航
• 宣布功能，并使用分类标签（新增、修复、破坏性变更）

基本用法

<Update label="January 10, 2025">

Added support for dark mode across all themes.

</Update>

添加描述

在日期下方添加上下文说明：

<Update label="January 5, 2025" description="Breaking change">

The `getData()` function now requires an options object.

</Update>

添加标签

使用标签对条目进行分类：

<Update label="December 20, 2024" tags={["breaking", "api"]}>

- Removed deprecated `legacyMode` option
- Updated authentication flow

</Update>

多个条目

堆叠多个 Update 组件即可构成完整的更新日志：

锚点链接和目录

每个 Update 会根据其 label 生成锚点 ID（label="January 10, 2025" 会生成 #january-10-2025）。label 也会显示在目录中，便于快速导航。

属性

RSS Feed

在包含 Update 组件的任意页面上添加 rss: true。Jamdesk 会在构建时生成 feed.xml。读者可订阅它以获取更新日志。

---
title: Changelog
rss: true
---

启用后：

• 页面标题旁会出现 RSS 图标，链接到订阅源
• <head> 中会添加 <link rel="alternate"> 标签，供 RSS 阅读器和浏览器自动发现
• 每个 <Update> 会成为一个 RSS 条目，以其 label 作为标题，并附带指向该条目的锚点链接

设置发布日期

使用 date 属性为订阅源中的每个条目设置 <pubDate>。若不设置 date，条目仍会出现在订阅源中，但没有时间戳。

<Update label="March 2025" date="2025-03-15" tags={["feature"]}>

Added dark mode support across all themes.

</Update>

Feed 内容

RSS 订阅源仅包含纯文本。Markdown 格式、MDX 组件、代码块和 HTML 都会从订阅源描述中剥离。请将第一句写成无需格式也能读懂的摘要。

Feed URL

订阅源位于 /cn/feed.xml（如果你的站点使用 hostAtDocs，则为 /cn/docs/feed.xml）。

生成的订阅源如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Acme Docs Changelog</title>
    <link>https://docs.acme.com</link>
    <description>Updates and changelog for Acme Docs</description>
    <item>
      <title>March 2025 — New dashboard</title>
      <link>https://docs.acme.com/changelog#march-2025</link>
      <pubDate>Sat, 15 Mar 2025 00:00:00 GMT</pubDate>
      <description>Added dark mode support across all themes.</description>
    </item>
  </channel>
</rss>

与其他工具集成

将订阅源 URL 添加到任何兼容 RSS 的服务中：

• Slack：将 /feed RSS 应用 添加到频道。
• Discord：使用 MonitoRSS 或类似机器人自动发布更新。
• 邮件：将订阅源连接到 Zapier 或 IFTTT，在有新条目时向订阅者发送邮件。
• 浏览器：Safari、Vivaldi 以及 Firefox（通过扩展）原生支持 RSS。

最佳实践

接下来做什么？