Keep a Changelog
Record the notable changes to your project
Keep a record of how your project has changed by writing changelog entries. The changelog will automatically populate with the files contained within the changelog
folder.

Configure your Changelog
Top-level Changelog
Configure a changelog for your project by creating a changelog folder.
Once you’ve configured your changelog, specify where it should appear within your docs in your docs.yml
.
View an example in GitHub of the ElevenLabs docs.yml
which powers their Changelog.
Section-level Changelog
Configure a changelog for your project by creating a changelog folder.
Once you’ve configured your changelog, specify where it should appear within your navigation in your docs.yml
.
Section-level changelogs cannot be nested within an api
entry. See API-level changelogs to add an API-level entry.
Write a Changelog Entry
Create a new changelog entry by writing a Markdown file. You can use .md
or .mdx
files. The benefit of using .mdx
is that you can leverage the built-in component library within an entry.
Entry date
Changelog entries are automatically sorted chronologically by the date specific in the file name. Specify the date of your entry using one of the following formats:
- MM-DD-YYYY (e.g., 10-06-2024)
- MM-DD-YY (e.g., 10-06-24)
- YYYY-MM-DD (e.g., 2024-04-21)
Linking to an Entry
Each changelog entry has a unique URL you can direct users to. For example, https://elevenlabs.io/docs/changelog/2025/3/31
RSS Feed
Changelogs automatically come with a RSS feed so users can subscribe to updates. Navigate to the RSS feed by appending .rss
to the changelog path. For example, https://elevenlabs.io/docs/changelog.rss