Update

Keep track of changes and updates

Use the Update component to display changelog entries, version updates, and release notes with consistent formatting.

​

Example

v0.1.1

Example update

You can add anything here, like a screenshot, a code snippet, or a list of changes.

Features

• Responsive design
• Anchor for each update
• Generated RSS feed entry for each update

How to use

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.

Props

label · string · required

Label for the update. Appears to the left of the update and creates an anchor link. Labels should be unique.

tags · string[]

Tags for the update. Shown as filters in the right side panel.

description · string

Description of the update. Appears below the label and tag.

rss · object

Title and description that will appear in the RSS feed entry for the update.

<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>

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.