Changelog
2 min
Changelog 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.
:::Changelog{title="Release Title"}
::ChangelogItem{type="added" description="What was added"}
::ChangelogItem{type="fixed" description="What was fixed"}
:::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.
<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>Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.