Keep A Changelog Format

What is Keep A Changelog?

Keep a Changelog is a popular format for maintaining changelogs in development projects. It provides a standardized structure for documenting changes, making it easier to maintain and parse.
It’s less flexible than writing release notes in their own Markdown file but widely used for purely technical changelogs.

Using Keep A Changelog with Openchangelog

Using Openchangelog you can transform your keep a changelog formatted CHANGELOG.md into a beatiful website.

1. Set your changelog source to a single file (e.g., your CHANGELOG.md) instead of a folder.
2. Openchangelog will automatically detect the format of the file.
3. The system will then parse the file using either the Keep a Changelog parser or our original parser, depending on the detected format

For more information on configuring available sources, please visit our Using Sources documentation.

Examples

Unity InputSystem, here is the CHANGELOG.md.
Git-Cliff, here is the CHANGELOG.md