Keep a Changelog Snippets
Markdown snippets for writing changelogs in Zed using the Keep a Changelog 1.1.0 structure.
The snippets are intentionally small and predictable: they insert standard changelog headings, release sections, category sections, and GitHub reference links with editable tab stops for versions, dates, owners, and repository names.
Installation
Install from the Zed Extension Gallery:
- Open Zed.
- Open the Extension Gallery with
Cmd+Shift+Xon macOS orCtrl+Shift+Xon Linux and Windows. - Search for
Keep a Changelog Snippets. - Click Install.
You can also open the command palette and run zed: extensions, then search for the extension there.
Install from GitHub
You can also install the extension directly from GitHub:
git clone https://github.com/ssh-den/zed-keep-a-changelog-snippets.gitThen open Zed, run zed: install dev extension from the command palette, and select the repository root.
You should select the folder that contains extension.toml.
Usage
Open a Markdown file, type a cl- prefix, and accept the completion to expand the snippet.
For example:
cl-initcreates a completeCHANGELOG.mdskeleton.cl-version-fullcreates a release section with all Keep a Changelog categories.cl-fixedcreates aFixedcategory section.cl-link-comparecreates a GitHub compare reference link.
Before publishing a release, delete any empty category sections so the changelog stays concise.
Snippets
| Prefix | Description |
|---|---|
cl-init |
Create a complete changelog skeleton with Keep a Changelog and Semantic Versioning links. |
cl-version |
Create a version heading. |
cl-version-full |
Create a version section with all Keep a Changelog categories. |
cl-entries |
Create all Keep a Changelog category sections. |
cl-added |
Create an Added section. |
cl-changed |
Create a Changed section. |
cl-deprecated |
Create a Deprecated section. |
cl-removed |
Create a Removed section. |
cl-fixed |
Create a Fixed section. |
cl-security |
Create a Security section. |
cl-link-first |
Create a reference link for the first release tag. |
cl-link-compare |
Create a reference link comparing two release tags. |
License
MIT