Changelog example
A changelog is written for humans, not from git log. This is the Keep a Changelog convention, which is what most projects follow.
changelog.md
# Changelog
All notable changes to this project are documented here.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project follows [semantic versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- Full-screen mode in the viewer.
## [1.2.0] - 2026-08-27
### Added
- Converters for PDF, Word, Excel, CSV and JSON.
- A knowledge base with a page per markdown topic.
### Changed
- The source box is now always on screen, so there is always somewhere to paste.
### Fixed
- Both panes in the split view now agree on height.
### Removed
- The illustrated empty state, which had nowhere to click.
## [1.1.0] - 2026-08-26
### Added
- Mermaid diagrams, drawn only for documents that contain one.
### Security
- Every rendered document passes through a sanitizer: scripts, event handlers
and `javascript:` URLs are stripped.
[Unreleased]: https://example.com/compare/v1.2.0...HEAD
[1.2.0]: https://example.com/compare/v1.1.0...v1.2.0
[1.1.0]: https://example.com/releases/tag/v1.1.0
Changelog
All notable changes to this project are documented here.
The format is based on Keep a Changelog, and this project follows semantic versioning.
Unreleased
Added
- Full-screen mode in the viewer.
1.2.0 - 2026-08-27
Added
- Converters for PDF, Word, Excel, CSV and JSON.
- A knowledge base with a page per markdown topic.
Changed
- The source box is now always on screen, so there is always somewhere to paste.
Fixed
- Both panes in the split view now agree on height.
Removed
- The illustrated empty state, which had nowhere to click.
1.1.0 - 2026-08-26
Added
- Mermaid diagrams, drawn only for documents that contain one.
Security
- Every rendered document passes through a sanitizer: scripts, event handlers
and
javascript:URLs are stripped.