---
title: Changelog
slug: docs/changelog-reference
docTags: 
createdAt: 2026-06-05T12:35:17.302Z
---

[Changelog](docId:0rGxak3VYBvD660Ymmbz7) blocks organize release notes into categorized entries. They are useful for communicating new features, improvements, bug fixes, breaking changes, and known issues.

## Syntax

You can add this component using either Markdown or MDX.

::::Tabs
:::Tab{title="Markdown"}
```markdown
:::Changelog{title="Release Title"}
::ChangelogItem{type="added" description="What was added"}
::ChangelogItem{type="fixed" description="What was fixed"}
:::
```
:::

:::Tab{title="MDX"}
```javascript
<Changelog title="Release Title">
  <ChangelogItem type="added" description="What was added"/>
  <ChangelogItem type="fixed" description="What was fixed"/>
  <ChangelogItem type="improved" description="What was improved"/>
  <ChangelogItem type="broken" description="What broke or was deprecated"/>
  <ChangelogItem type="knownIssue" description="Known issues"/>
</Changelog>
```
:::
::::

Changelog items support the following types:

- `added`
- `fixed`
- `improved`
- `broken`
- `knownIssue`

## MDX example

The following example creates a changelog for a product release with multiple categorized updates.

```javascript
<Changelog title="v2.0.0 — Multi-Space Support">
  <ChangelogItem type="added" description="Multi-space navigation with navbar switcher"/>
  <ChangelogItem type="added" description="Per-site appearance overrides (colors, template, fonts)"/>
  <ChangelogItem type="improved" description="Hot reload now updates config changes in real time"/>
  <ChangelogItem type="fixed" description="Code drawer not appearing on API endpoint pages"/>
  <ChangelogItem type="knownIssue" description="Duplicate heading slugs in table of contents"/>
</Changelog>

<Changelog title="v1.5.0 — Docusaurus Support">
  <ChangelogItem type="added" description="Auto-detect and render Docusaurus projects"/>
  <ChangelogItem type="added" description="Blog directory as separate space"/>
  <ChangelogItem type="improved" description="Custom CSS extraction from Docusaurus themes"/>
  <ChangelogItem type="fixed" description="TypeScript config files crashing on load"/>
  <ChangelogItem type="broken" description="Deprecated: --no-public flag replaced with --private"/>
</Changelog>
```