mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
4daf91ff69
* docs: document shareable changelog filter URLs * docs: translate changelog filter URL note to es, fr, zh --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
166 lines
6.3 KiB
Plaintext
166 lines
6.3 KiB
Plaintext
---
|
|
title: "Changelogs"
|
|
description: "Create product changelogs with date-based entries, RSS feed support, and subscriber notifications to keep users informed about updates."
|
|
keywords: ["product updates", "release notes", "RSS"]
|
|
boost: 3
|
|
---
|
|
|
|
Create a changelog for your docs by adding [Update components](/components/update) to a page.
|
|
|
|
See the [Mintlify changelog](/changelog) as an example: you can include links, images, text, and demos of your new features in each update.
|
|
|
|
## Set up your changelog
|
|
|
|
<Steps>
|
|
<Step title="Create a page for your changelog">
|
|
1. Create a new page in your docs such as `changelog.mdx` or `updates.mdx`.
|
|
2. Add your changelog page to your navigation scheme in your `docs.json`.
|
|
</Step>
|
|
<Step title="Add Update components to your changelog">
|
|
Add an `Update` for each changelog entry.
|
|
|
|
Include relevant information like feature releases, bug fixes, or other announcements.
|
|
</Step>
|
|
</Steps>
|
|
|
|
```mdx Example changelog.mdx
|
|
---
|
|
title: "Changelog"
|
|
description: "Product updates and announcements"
|
|
---
|
|
<Update label="March 2025" description="v0.0.10">
|
|
Added a new Wintergreen flavor.
|
|
|
|
Released a new version of the Spearmint flavor, now with 10% more mint.
|
|
</Update>
|
|
|
|
<Update label="February 2025" description="v0.0.09">
|
|
Released a new version of the Spearmint flavor.
|
|
</Update>
|
|
```
|
|
|
|
## Customize your changelog
|
|
|
|
Control how people navigate your changelog and stay up to date with your product information.
|
|
|
|
### Table of contents
|
|
|
|
Each `label` property for an `Update` automatically creates an entry in the right sidebar's table of contents. This is the default navigation for your changelog.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/changelog-toc-light.png"
|
|
alt="Changelog with table of contents displayed in light mode."
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/changelog-toc-dark.png"
|
|
alt="Changelog with table of contents displayed in dark mode."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
### Tag filters
|
|
|
|
Add `tags` to your `Update` components to replace the table of contents with tag filters. Users can filter the changelog by selecting one or more tags.
|
|
|
|
When a user selects multiple tags, the changelog shows only updates that include every selected tag. The changelog hides updates without tags whenever a filter is active.
|
|
|
|
Selected tags are reflected in the page URL as a `?tags=` query parameter, so users can share deep links to a filtered view of the changelog. Opening a link like `/changelog?tags=Spearmint` activates matching sidebar filters on load, and updating filters keeps the URL in sync. Separate multiple tags with commas, for example `/changelog?tags=Spearmint,Peppermint`.
|
|
|
|
```mdx Tag filters example wrap
|
|
<Update label="March 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
|
|
Added a new Wintergreen flavor.
|
|
|
|
Released a new version of the Spearmint flavor, now with 10% more mint.
|
|
</Update>
|
|
|
|
<Update label="February 2025" description="v0.0.09" tags={["Spearmint"]}>
|
|
Released a new version of the Spearmint flavor.
|
|
</Update>
|
|
|
|
<Update label="January 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
|
|
Deprecated the Peppermint flavor.
|
|
|
|
Released a new version of the Spearmint flavor.
|
|
</Update>
|
|
```
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/changelog-filters-light.png"
|
|
alt="Changelog in light mode with the Peppermint tag filter selected."
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/changelog-filters-dark.png"
|
|
alt="Changelog in dark mode with the Peppermint tag filter selected."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
<Tip>
|
|
Using `custom`, `center`, or `wide` page modes hides the table of contents and changelog filters. Learn more about [page modes](/organize/pages#page-mode).
|
|
</Tip>
|
|
|
|
### Subscribable changelogs
|
|
|
|
<Note>RSS feeds are only available on public documentation.</Note>
|
|
|
|
{/* vale Vale.Terms = NO */}
|
|
Use `Update` components to create a subscribable RSS feed at your page URL with `/rss.xml` appended. For example, `mintlify.com/docs/changelog/rss.xml`.
|
|
{/* vale Vale.Terms = YES */}
|
|
|
|
The RSS feed publishes entries when you add new `Update` components and when you modify headings inside of existing `Update` components.
|
|
|
|
RSS feed entries contain pure Markdown only. They exclude components, code, and HTML elements. Use the `rss` property to provide alternative text descriptions for RSS subscribers when your updates contain excluded content.
|
|
|
|
```xml Example RSS feed
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
|
|
<channel>
|
|
<title><![CDATA[Product updates]]></title>
|
|
<description><![CDATA[New updates and improvements]]></description>
|
|
<link>https://mintlify.com/docs</link>
|
|
<generator>RSS for Node</generator>
|
|
<lastBuildDate>Mon, 21 Jul 2025 21:21:47 GMT</lastBuildDate>
|
|
<atom:link href="https://mintlify.com/docs/changelog/rss.xml" rel="self" type="application/rss+xml"/>
|
|
<copyright><![CDATA[Mintlify]]></copyright>
|
|
<docs>https://mintlify.com/docs</docs>
|
|
<item>
|
|
<title><![CDATA[June 2025]]></title>
|
|
<link>https://mintlify.com/docs/changelog#june-2025</link>
|
|
<guid isPermaLink="true">https://mintlify.com/docs/changelog#june-2025</guid>
|
|
<pubDate>Mon, 23 Jun 2025 16:54:22 GMT</pubDate>
|
|
</item>
|
|
</channel>
|
|
</rss>
|
|
```
|
|
|
|
RSS feeds can integrate with Slack, email, or other subscription tools to notify users of product changes. Some options include:
|
|
|
|
* [Slack](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack)
|
|
* [Email](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) via Zapier
|
|
* Discord bots like [Readybot](https://readybot.io) or [RSS Feeds to Discord Bot](https://rss.app/en/bots/rssfeeds-discord-bot)
|
|
|
|
To make the RSS feed discoverable, you can display an RSS icon button that links to the feed at the top of the page. Add `rss: true` to the page frontmatter:
|
|
|
|
```mdx
|
|
---
|
|
rss: true
|
|
---
|
|
```
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/changelog-rss-button-light.png"
|
|
alt="Changelog page in light mode with RSS feed button enabled."
|
|
className="block dark:hidden"
|
|
/>
|
|
<img
|
|
src="/images/changelog-rss-button-dark.png"
|
|
alt="Changelog page in dark mode with RSS feed button enabled."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|