---
title: Update
description: Timeline-style changelog entries with dates, descriptions, and category tags. Integrates with your Table of Contents for navigation.
---

The Update component creates timeline-style changelog entries that automatically integrate with your Table of Contents. Each entry can have a date label, description, and category tags, which makes it a good fit for "What's New" pages, API changelogs, and release notes.

Use Update when:
- **Documenting releases** with version numbers or dates
- **Building changelogs** that readers can navigate via ToC
- **Announcing features** with categorized tags (new, fix, breaking)

<Tip>
Built a changelog from these entries? You can surface it inside your own product with a "What's new?" button and an unread dot. See [Embed Your Changelog](/development/embed-page).
</Tip>

## Basic Usage

<Update label="January 10, 2025">
Added support for dark mode across all themes.
</Update>

```mdx
<Update label="January 10, 2025">
Added support for dark mode across all themes.
</Update>
```

## With Description

Add context below the date:

<Update label="January 5, 2025" description="Breaking change">
The `getData()` function now requires an options object.
</Update>

```mdx
<Update label="January 5, 2025" description="Breaking change">
The `getData()` function now requires an options object.
</Update>
```

## With Tags

Categorize entries with tags:

<Update label="December 20, 2024" tags={["breaking", "api"]}>
- Removed deprecated `legacyMode` option
- Updated authentication flow
</Update>

```mdx
<Update label="December 20, 2024" tags={["breaking", "api"]}>
- Removed deprecated `legacyMode` option
- Updated authentication flow
</Update>
```

## Multiple Entries

Stack Update components for a complete changelog:

<Update label="December 15, 2024" tags={["feature"]}>
New export functionality for PDF and CSV formats.
</Update>

<Update label="December 10, 2024" tags={["fix"]}>
Fixed timezone handling in scheduled posts.
</Update>

<Update label="December 1, 2024" tags={["deprecation"]}>
The `v1` API endpoints are now deprecated. Migrate to `v2` by March 2025.
</Update>

## Anchor Links and TOC

Each Update generates an anchor ID from its label (`label="January 10, 2025"` creates `#january-10-2025`). Labels also appear in the Table of Contents for quick navigation.

## Props

<ParamField name="label" type="string">
  Date or version label (creates anchor ID).
</ParamField>

<ParamField name="description" type="string">
  Secondary text below the label.
</ParamField>

<ParamField name="tags" type="string[]">
  Category tags displayed as badges.
</ParamField>

<ParamField name="date" type="string">
  ISO date string (e.g., `"2025-03-15"`) used for the RSS feed `pubDate`. Not rendered visually; the `label` remains your display text.
</ParamField>

## RSS Feed

Let your readers subscribe to changelog updates. Add `rss: true` to any page with Update components, and Jamdesk auto-generates a `feed.xml` during builds.

```yaml
---
title: Changelog
rss: true
---
```

When enabled:
- An RSS icon appears next to the page title, linking to the feed
- A `<link rel="alternate">` tag is added to the `<head>` for auto-discovery, so RSS readers and browsers can find the feed automatically
- Each `<Update>` becomes an RSS item with its label as the title and an anchor link back to the entry

### Setting publication dates

Use the `date` prop to set the `<pubDate>` for each entry in the feed. Without `date`, the entry appears in the feed but without a timestamp.

```mdx
<Update label="March 2025" date="2025-03-15" tags={["feature"]}>
Added dark mode support across all themes.
</Update>
```

### Feed content

RSS feeds contain plain text only. Markdown formatting, MDX components, code blocks, and HTML are stripped from the feed description, so write your first sentence as a clear summary that works without formatting.

### Feed URL

The feed is available at `/feed.xml` (or `/docs/feed.xml` if your site uses [hostAtDocs](/deploy/custom-domains)).

The generated feed looks like this:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Acme Docs Changelog</title>
    <link>https://docs.acme.com</link>
    <description>Updates and changelog for Acme Docs</description>
    <item>
      <title>March 2025 — New dashboard</title>
      <link>https://docs.acme.com/changelog#march-2025</link>
      <pubDate>Sat, 15 Mar 2025 00:00:00 GMT</pubDate>
      <description>Added dark mode support across all themes.</description>
    </item>
  </channel>
</rss>
```

### Integrating with other tools

Subscribers can use the feed URL with any RSS-compatible service:

- Slack: add the `/feed` [RSS app](https://slack.com/apps/A0F81R7U7-rss) to a channel.
- Discord: use [MonitoRSS](https://monitorss.xyz/) or a similar bot to post updates automatically.
- Email: connect the feed to [Zapier](https://zapier.com/) or [IFTTT](https://ifttt.com/) to email subscribers on new entries.
- Browsers: Safari, Vivaldi, and Firefox (via extensions) support RSS natively.

<Tip>
  You can add `rss: true` to multiple pages. All Update entries across RSS-enabled pages are combined into a single site-wide `feed.xml`.
</Tip>

## Best Practices

<AccordionGroup>
  <Accordion title="Use unique labels" icon="fingerprint" defaultOpen>
    Each label creates an anchor ID, so use unique labels to ensure proper deep linking:
    - Use specific dates: `January 10, 2025` (not just `January 2025`)
    - Include version numbers: `v2.1.0` vs `v2.0.0`
    - Duplicate labels will create duplicate IDs, breaking anchor navigation
  </Accordion>

  <Accordion title="Use consistent date formats" icon="calendar">
    Pick one format and stick with it:
    - `January 10, 2025` (recommended)
    - `2025-01-10` (ISO format)
    - `v2.0.0` (for version-based changelogs)
  </Accordion>

  <Accordion title="Use meaningful tags" icon="tags">
    Common tags with automatic color coding:

    | Tag | Color | Use for |
    |-----|-------|---------|
    | `breaking` | Red | Breaking changes |
    | `feature` / `new` | Green | New functionality |
    | `deprecation` / `deprecated` | Amber | Deprecated features |
    | Other tags | Gray | General categories like `api`, `fix` |
  </Accordion>

  <Accordion title="Keep entries scannable" icon="eye">
    - Lead with the most important change
    - Use bullet points for multiple items
    - Link to detailed docs for complex changes
  </Accordion>
</AccordionGroup>

## What's Next?

<Columns cols={2}>
  <Card title="Components Overview" icon="puzzle-piece" href="/components/overview">
    Browse all available components
  </Card>
  <Card title="MDX Basics" icon="file-code" href="/content/mdx-basics">
    Learn how to use components in MDX
  </Card>
</Columns>
