chan-stringify

Plugin to compile chast to a keepachangelog markdown.

Note

Since v3.0 this plugin is ESM only.

Install

npm install @geut/chan-stringify

Use

import unified from 'unified'
import markdown from 'remark-parse'
import { remarkToChan } from '@geut/remark-chan'
import { stringify } from '@geut/chan-stringify'

unified()
  .use(markdown)
  .use(remarkToChan)
  //.. more plugins
  .use(stringify)

API

origin.use(stringify[, destination][, options])

Changelog

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

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Changed

• Update and improvement of Polish translation from @m-aciek.
• package1
  • test1
  • test2

0.0.4 - 2014-08-09

Added

• Better explanation of the difference between the file ("CHANGELOG") and its function "the change log".

Changed

• Refer to a "change log" instead of a "CHANGELOG" throughout the site to differentiate between the file and the purpose of the file — the logging of changes.

Removed

• Remove empty sections from CHANGELOG, they occupy too much space and create too much noise in the file. People will have to assume that the missing sections were intentionally left out because they contained no notable changes.

0.0.3 - 2014-08-09 [YANKED]

0.0.2 - 2014-07-10

Added

• Explanation of the recommended reverse chronological release ordering.

0.0.1 - 2014-05-31

Added

• This CHANGELOG file to hopefully serve as an evolving example of a standardized open source project CHANGELOG.
• CNAME file to enable GitHub Pages custom domain
• README now contains answers to common questions about CHANGELOGs
• Good examples and basic guidelines, including proper date formatting.
• Counter-examples: "What makes unicorns cry?"