Goal

This package provides a CLI for converting a CHANGELOG.md file that follows the Keep a Changelog convention into a react functional component with permalinks and a GitHub look and feel.

Permalinks

This package generates permanent links for each section.

Let's take a changelog example:

``markdown


[0.3.0] - 2003-03-03

$3

- A bullet.

[0.2.0] - 2002-02-02

$3

- Another bullet.

[0.1.0] - 2001-01-01

$3

- Last bullet.
`

GitHub will generates these URLs:

- 030---2003-03-03
- added
- 020---2002-02-02
- added-1
- 010---2001-01-01
- added-2

This makes the added anchors ephemeral.
Indeed, when you release another version of your package, all the existing anchors will change because GitHub will increment their trailing number:

- 040---2004-04-04
- added
- 030---2003-03-03
- added-1 (used to be _added_)
- 020---2002-02-02
- added-2 (used to be _added-1_)
- 010---2001-01-01
- added-3 (used to be _added-2_)

On the other hand, this package will generate these anchors:

- 0.3.0
- 0.3.0-added
- 0.2.0
- 0.2.0-added
- 0.1.0
- 0.1.0-added

By prefixing the _type of changes_ section anchor with the release name, we guarantee that the link will be permanent.

Usage

1. Add this package to your dependencies: npm install --save-dev changelog-to-react-component-ts.
2. Add "changelog-to-react-component-ts": "changelog-to-react-component-ts" to your package.json scripts.
3. Run yarn changelog-to-react-component-ts.
####
4. Flags
- --regenerateCss set to false if you have a custom css style.
- --outputDirectoryPath default set to src/components/Changelog
- --markdownChangelogPath default path of CHANGELOG.md file default is CHANGELOG.md

You can get the command help by running yarn run changelog-to-html -- --help`.

Acknowledgements

This is a modified version of https://github.com/TylerAHolden/changelog-to-react-component - I wanted a Typescript react component