Changelog

Keep your users informed with this Changelog template. Document project updates, bug fixes, and new features in a clear, chronological format.

Markdown
# Changelog
All notable changes to this project will be documented in this file.

## [1.2.0] - 2025-12-21
### ✨ Added
- New "Dark Mode" toggle in settings.
- Integration with Google Drive for auto-saves.

### 🛠 Changed
- Improved search algorithm for faster results.
- Updated documentation for API v2.

### 🐛 Fixed
- Fixed a bug where images wouldn't render in Safari.
- Resolved memory leak in the editor component.

## [1.1.0] - 2025-11-15
### ✨ Added
- Initial release of the Markdown Editor.
Preview

Changelog

All notable changes to this project will be documented in this file.

[1.2.0] - 2025-12-21

✨ Added

  • New "Dark Mode" toggle in settings.
  • Integration with Google Drive for auto-saves.

🛠 Changed

  • Improved search algorithm for faster results.
  • Updated documentation for API v2.

🐛 Fixed

  • Fixed a bug where images wouldn't render in Safari.
  • Resolved memory leak in the editor component.

[1.1.0] - 2025-11-15

✨ Added

  • Initial release of the Markdown Editor.

How to use this template

  1. 1

    Copy the Markdown

    Click the Copy button above to put the full template on your clipboard.

  2. 2

    Paste into your editor

    Paste into VS Code, Obsidian, the mdkit editor, or any Markdown editor. The template renders cleanly in any GFM-compatible viewer.

  3. 3

    Fill in your content

    Replace the placeholder text with your own. Delete sections you don't need — the template is a starting point, not a contract.

  4. 4

    Export or share

    Commit to Git, export to HTML or PDF, or paste into your team's wiki.

What it solves

Users and developers need to know what has changed between versions. A Changelog solves this by providing a chronological list of significant changes, helping users decide when to upgrade and what to expect.

Key features

  • Chronological ordering of versions
  • Categorized changes (Added, Changed, Deprecated, Removed, Fixed, Security)
  • Dates for each release
  • Reference to Semantic Versioning

Pro tips

  • ›Follow the 'Keep a Changelog' standard format.
  • ›Group changes by type (e.g., Features, Bug Fixes) for readability.
  • ›Link to specific pull requests or issues for deep dives.

Related templates

Project README

Use this standard Project README template to document your software. Includes sections for installation, features, tech stack, and usage instructions.

API Documentation

Create clear API documentation with this Markdown template. Define endpoints, parameters, authentication methods, and response examples for developers.

Project Post-Mortem

Conduct effective project reviews with this Post-Mortem template. Analyze successes, failures, and key lessons learned to improve future projects.