Changelog
All notable changes to this project will be documented in this file.
See Conventional Commits for commit guidelines.
4.0.0
🔧 Fixed
- remark-conventional-commit-changelog-timeline: replace semver-regex (2d60ca5)
✨ Features
- remark-conventional-commit-changelog-timeline: render changelogs directly (2de0031)
💥 BREAKING CHANGES
- remark-conventional-commit-changelog-timeline: The default export now accepts a Markdown string and returns HTML instead of a Unified plugin. Remove dateDivLocale, dateDivMarkup, defaults, Opts, and DateParamsObj. Dates use the fixed codsen.com format.
4.0.0
✨ Features
- Render Codsen changelog Markdown directly as timeline HTML with no dependencies.
💥 BREAKING CHANGES
- Replace the Unified plugin with
changelogTimeline(markdown), returning an HTML string. Remove locale and markup callbacks, thedefaultsexport, and option types. Dates now use the fixed codsen.com format. See the migration guide.
Migration instructions to version 4
Version 4 renders Codsen changelog Markdown directly to an HTML string:
import changelogTimeline from "remark-conventional-commit-changelog-timeline";
const html = changelogTimeline(markdown);
Replace the Unified pipeline previously used to render the changelog with this
call. Remove .value access: the result is already a string. Remove the
dateDivLocale and dateDivMarkup options and imports of defaults, Opts,
and DateParamsObj.
Dates now match codsen.com: 2022-08-12 becomes
12 Aug <span>2022</span> inside .release-date. September is Sept. Dates
are independent of the machine’s locale and time zone. Existing timeline CSS
classes and section emojis remain available.
The supported format is the one used by Codsen’s historical changelogs:
- Plain or linked stable release headings with a date, under
#,##, or###. - Change sections, paragraphs, unordered and ordered lists, nested lists, fenced code, blockquotes, and horizontal rules.
- Inline code,
**strong**,*emphasis*or_emphasis_, inline links, and HTTP or HTTPS autolinks. - Numeric character references and the named references
amp,lt,gt,quot,apos,nbsp, andhellipused by this format.
This is a focused changelog renderer. Tables, images, reference links, raw HTML, and the full CommonMark grammar are outside its contract. Raw HTML is escaped. Use a general Markdown renderer for other document formats. Empty input returns an empty string. Nonempty output has a leading and trailing newline.
Typography is a separate editorial step. The website’s data generator still
applies remark-typography before calling the renderer. The package itself
does not alter quotes, dashes, or word spacing.
The function is synchronous and returns only the HTML. The small release-note documents it targets do not need callback-driven formatting or progress APIs.
3.3.3
🔧 Fixed
- remark-typography: preserve phrasing context (371dd5e)
3.3.0
🔧 Fixed
- resolve various review findings (b60e9ee)
- retire direct publish aliases (f98e31e)
- tweak deps (bd41b1f)
- type raw changelog markup explicitly (b5ead07)
✨ Features
- refresh the tooling and generate with the latest dependencies (781f802)
3.1.0
✨ Features
- move the source back to monorepo, update deps (6f470d9)
3.0.7
🔧 Fixed
- move out of parked (f9a1e1b)
3.0.0
✨ Features
- remove pure-ESM setup (1cf14c4)
💥 BREAKING CHANGES
- you can
requirethis package now; also minimum Node requirements are v14.18 or above
2.0.0
✨ Features
- allow date customisation (4d90331)
💥 BREAKING CHANGES
- implement a callback interface to fully customise the date
divcontents
1.2.0
✨ Features
- wrap emoji with a
span(9d9e25f)
1.1.0
✨ Features
- add more emoji and stop using word bugs in patch bumps (90a1d0e)
1.0.1
🔧 Fixed
- init (61d8011)