mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
16518ef996
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
99 lines
3.0 KiB
Plaintext
99 lines
3.0 KiB
Plaintext
---
|
||
title: "Update"
|
||
description: "使用 update 组件以带日期的结构化时间轴格式展示产品更新、发行说明和更新日志条目。"
|
||
keywords: ["更新日志", "产品更新", "版本说明"]
|
||
boost: 3
|
||
---
|
||
|
||
使用 `Update` 组件以一致的格式展示更新日志条目、版本更新和版本说明。
|
||
|
||
<Update label="示例" description="v0.1.1">
|
||
## 示例更新
|
||
|
||
你可以在这里添加任何内容，比如截图、代码片段或变更列表。
|
||
|
||
<Frame>
|
||
<img
|
||
className="block"
|
||
src="https://mintlify-assets.b-cdn.net/hero-light.png"
|
||
alt="PearsDB 入门页面的截图，用作 Update 组件中图片的示例。"
|
||
/>
|
||
</Frame>
|
||
|
||
### 新功能
|
||
- 自适应设计
|
||
- 为每个更新提供锚点
|
||
- 为每次更新生成 RSS 源条目
|
||
</Update>
|
||
|
||
<div id="how-to-use">
|
||
## 使用说明
|
||
</div>
|
||
|
||
```mdx Update example
|
||
<Update label="2024-10-11" description="v0.1.0" tags={["Mintlify"]}>
|
||
这是一个带有标签、说明和标记的更新。
|
||
</Update>
|
||
```
|
||
|
||
使用多个 `Update` 组件创建[更新日志](/zh/create/changelogs)。
|
||
|
||
Update 组件会自动生成 RSS 订阅源条目。条目只包含纯 Markdown——不会包含组件、代码块、行内代码或原始 HTML 元素。
|
||
|
||
如果你的更新中包含组件或 HTML，请使用 `rss` 属性为 RSS 订阅者提供替代文本。
|
||
|
||
```mdx Custom RSS content
|
||
<Update
|
||
label="March 2025"
|
||
description="v2.0.0"
|
||
rss={{
|
||
title: "2025 年 3 月 - 重大改版",
|
||
description: "全新 UI 改版及新组件"
|
||
}}
|
||
>
|
||
## New dashboard
|
||
|
||
<Frame>
|
||
<img src="/dashboard.png" alt="New dashboard UI displaying updated components." />
|
||
</Frame>
|
||
|
||
Check out our redesigned dashboard with improved navigation.
|
||
</Update>
|
||
```
|
||
|
||
|
||
<div id="props">
|
||
## Props
|
||
</div>
|
||
|
||
<ResponseField name="label" type="string" required>
|
||
更新的标签。显示在更新项左侧，并使用与标题相同的[自动锚点 ID 规则](/zh/create/text#automatic-anchor-ids)生成一个锚点链接。使用唯一的标签以创建不同的锚点链接。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="tags" type="string[]">
|
||
更新的标签。显示在右侧面板中，作为筛选条件。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="description" type="string">
|
||
更新的说明。显示在标签和标签列表下方。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="rss" type="object">
|
||
Update 组件会自动生成 RSS feed 条目。使用 `rss` 属性可以创建一个带有自定义标题和说明的单个 RSS feed 条目。
|
||
|
||
如果未提供该属性：
|
||
|
||
- 带有 Markdown 标题的更新会为每个标题创建一个单独的 RSS feed 条目。
|
||
- 不带 Markdown 标题的更新会使用 `label` 作为标题创建一个单独的 RSS feed 条目。
|
||
|
||
<Expandable title="属性">
|
||
<ResponseField name="title" type="string">
|
||
RSS feed 条目的自定义标题。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="description" type="string">
|
||
RSS feed 条目的自定义说明。
|
||
</ResponseField>
|
||
</Expandable>
|
||
</ResponseField>
|