Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions content/components/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: "Update"
description: "Keep track of changes and updates"
icon: "rectangle-history"
---

The `Update` component is used to keep track of changes and updates.

<Update label="2024-10-12" description="v0.1.1">
<Frame>
<img
className="block"
src="https://mintlify-assets.b-cdn.net/hero-light.png"
/>
</Frame>

## Changelog

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

#### Features
- Responsive design
- Sticky section for each changelog
</Update>

<Update label="2024-10-11" description="v0.1.0">
### How to use
```md
<Update label="2024-10-12" description="v0.1.1">
This is how you use a changelog with a label
and a description.
</Update>
<Update label="2024-10-11" description="v0.1.0">
This is how you use a changelog with a label
and a description.
</Update>
```

You can use multiple `Update` components to create changelogs.
</Update>

<Tip>
Each `label` creates an anchor and also shows up on the table of contents on the right.
</Tip>

## Props

<ResponseField name="label" type="string" required>
Label in the changelog, on the sticky left side.
</ResponseField>

<ResponseField name="description" type="string">
Description below the label in the Changelog preview.
</ResponseField>
6 changes: 5 additions & 1 deletion mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@
"style": "roundedRectangle",
"arrow": false
},
"codeBlock": {
"mode": "auto"
},
"feedback": {
"thumbsRating": true,
"suggestEdit": true
Expand Down Expand Up @@ -200,7 +203,8 @@
"content/components/mermaid-diagrams",
"content/components/steps",
"content/components/tabs",
"content/components/tooltips"
"content/components/tooltips",
"content/components/update"
]
},
{
Expand Down