mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
6dbe1d1cd5
* remove `rss` object from Update page * update changelog info * update example RSS feed
51 lines
1.3 KiB
Plaintext
51 lines
1.3 KiB
Plaintext
---
|
|
title: "Update"
|
|
description: "Keep track of changes and updates"
|
|
icon: "list-collapse"
|
|
---
|
|
|
|
Use the `Update` component to display changelog entries, version updates, and release notes with consistent formatting.
|
|
|
|
<Update label="Example" description="v0.1.1">
|
|
## Example update
|
|
|
|
You can add anything here, like a screenshot, a code snippet, or a list of changes.
|
|
|
|
<Frame>
|
|
<img
|
|
className="block"
|
|
src="https://mintlify-assets.b-cdn.net/hero-light.png"
|
|
alt=""
|
|
/>
|
|
</Frame>
|
|
|
|
### Features
|
|
- Responsive design
|
|
- Anchor for each update
|
|
- Generated RSS feed entry for each update
|
|
</Update>
|
|
|
|
## How to use
|
|
|
|
```mdx Update example
|
|
<Update label="2024-10-11" description="v0.1.0" tags={["Mintlify"]}>
|
|
This is an update with a label, description, and tag.
|
|
</Update>
|
|
```
|
|
|
|
Use multiple `Update` components to create [changelogs](/guides/changelogs).
|
|
|
|
## Props
|
|
|
|
<ResponseField name="label" type="string" required>
|
|
Label for the update. Appears to the left of the update and creates an anchor link. Labels should be unique.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="tags" type="string[]">
|
|
Tags for the update. Shown as filters in the right side panel.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="description" type="string">
|
|
Description of the update. Appears below the label and tag.
|
|
</ResponseField>
|