Skip to main content
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.
Screenshot of the PearsDB Introduction page as an example of an image in an Update component.

​
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 an update with a label, description, and tag.
</Update>
Use multiple Update components to create changelogs. Update components automatically generate RSS feed entries. The entries contain pure Markdown only—components, code blocks, inline code, and raw HTML elements are not included. If your update includes components or HTML, use the rss prop to provide alternative text for RSS subscribers.
Custom RSS content
<Update
  label="March 2025"
  description="v2.0.0"
  rss={{
    title: "March 2025 - Major redesign",
    description: "Complete UI overhaul with new components"
  }}
>
  ## New dashboard

  <Frame>
    <img src="/dashboard.png" alt="New dashboard UI displaying updated components." />
  </Frame>

  Check out our redesigned dashboard with improved navigation.
</Update>

​
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
Update components automatically generate RSS feed entries. Use the rss property to create a single RSS feed entry with a custom title and description.If not provided:
  • Updates with Markdown headings create a separate RSS feed entry for each heading.
  • Updates without Markdown headings create a single RSS feed entry using the label as the title.