mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Kathryn Isabelle Lawrence
163ddfa782
* start changelogs guide * start adding update component stuff * Update `update` component page * update `rss` info * changelogs * wrap code block * update intro * add dark mode ToC image * update procedural sections * update images * fix dark mode image * fix link * add changelog in ctx menu screenshot * light and dark mode images for ctx menu * update changelog for test * test * update docs * add xml example * add upate example in feed * rss in frontmatter not docs json * update docs with frontmatter and image change * update button images * update images again * copyedits --------- Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
77 lines
2.1 KiB
Plaintext
77 lines
2.1 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 how you use a changelog with a label, description,
|
|
and tags.
|
|
</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>
|
|
|
|
<ResponseField name="rss" type="object">
|
|
Title and description that will appear in the RSS feed entry for the update.
|
|
|
|
```mdx wrap
|
|
<Update label="v1.0.1" rss={{ title: "v1.0.1 released", description: "Bug fixes and improvements" }}>
|
|
# What's New in v1.0.1
|
|
|
|
* Bug fixes
|
|
* Improvements
|
|
</Update>
|
|
```
|
|
|
|
```xml Example Update item in RSS feed
|
|
<item>
|
|
<title><![CDATA[v1.0.1 released]]></title>
|
|
<description><![CDATA[Bug fixes and improvements]]></description>
|
|
<link>https://mintlify.com/changelog#v101</link>
|
|
<guid isPermaLink="true">https://mintlify.com/changelog#v101</guid>
|
|
<pubDate>Fri, 20 Jun 2025 21:32:19 GMT</pubDate>
|
|
</item>
|
|
```
|
|
|
|
Learn more about [subscribable changelogs](/guides/changelogs#subscribable-changelogs).
|
|
</ResponseField>
|