Skip to main content

Create a changelog for your docs by adding Update components to a page.

Check out the Docfiy changelog as an example: you can include links, images, text, and demos of your new features in each update.

Set up your changelog

1

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.
2

Add Update components to your changelog

Add an Update for each changelog entry.

Include relevant information like feature releases, bug fixes, or other announcements.

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.

Changelog with table of contents displayed in light mode.

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.

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>
Changelog in light mode with the Peppermint tag filter selected.

Using custom, center, or wide page modes hides the table of contents and changelog filters. Learn more about page modes.

Subscribable changelogs

RSS feeds are only available on public documentation.

Use Update components to create a subscribable RSS feed at your page URL with /rss.xml appended. For example, docfiy.com/docs/changelog/rss.xml.

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.

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://docfiy.com/docs</link>
    <generator>RSS for Node</generator>
    <lastBuildDate>Mon, 21 Jul 2025 21:21:47 GMT</lastBuildDate>
    <atom:link href="https://docfiy.com/docs/changelog/rss.xml" rel="self" type="application/rss+xml"/>
    <copyright><![CDATA[Docfiy]]></copyright>
    <docs>https://docfiy.com/docs</docs>
    <item>
      <title><![CDATA[June 2025]]></title>
      <link>https://docfiy.com/docs/changelog#june-2025</link>
      <guid isPermaLink="true">https://docfiy.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:

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:

---
rss: true
---
Changelog page in light mode with RSS feed button enabled.