Skip to content

Commit ed6622c

Browse files
committed
add changelog
1 parent 6cabe3e commit ed6622c

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

content/components/changelogs.mdx

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: "Changelogs"
3+
description: "Keep track of changes and updates"
4+
icon: "rectangle-history"
5+
---
6+
7+
The `Update` component is used to keep track of changes and updates.
8+
9+
<Update label="10-12-2024" description="v0.1.1">
10+
<Frame>
11+
<img
12+
className="block"
13+
src="https://mintlify-assets.b-cdn.net/hero-light.png"
14+
/>
15+
</Frame>
16+
17+
## Changelog
18+
19+
You can add anything here, like a screenshot, a code snippet, or a list of changes.
20+
21+
#### Features
22+
- Responsive design
23+
- Sticky section for each changelog
24+
</Update>
25+
26+
<Update label="10-11-2024" description="v0.1.0">
27+
### How to use
28+
```md
29+
<Update label="10-12-2024" description="v0.1.1">
30+
This is how you use a changelog with a label
31+
and a description.
32+
</Update>
33+
<Update label="10-11-2024" description="v0.1.0">
34+
This is how you use a changelog with a label
35+
and a description.
36+
</Update>
37+
```
38+
39+
You can use multiple `Update` components to create changelogs.
40+
</Update>
41+
42+
<Tip>
43+
Each `label` creates an anchor and also shows up on the table of contents on the right.
44+
</Tip>
45+
46+
## Props
47+
48+
<ResponseField name="label" type="string" required>
49+
Label in the changelog, on the sticky left side.
50+
</ResponseField>
51+
52+
<ResponseField name="description" type="string">
53+
Description below the label in the Changelog preview.
54+
</ResponseField>

mint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@
193193
"content/components/callouts",
194194
"content/components/cards",
195195
"content/components/card-groups",
196+
"content/components/changelogs",
196197
"content/components/code",
197198
"content/components/code-groups",
198199
"content/components/frames",

0 commit comments

Comments
 (0)