https://github.com/atian25/git-changelog-parser
Parse Git `ChangeLog.md / History.md` to JSON
https://github.com/atian25/git-changelog-parser
changelog history markdown parser
Last synced: 2 months ago
JSON representation
Parse Git `ChangeLog.md / History.md` to JSON
- Host: GitHub
- URL: https://github.com/atian25/git-changelog-parser
- Owner: atian25
- Created: 2019-03-26T08:04:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-26T08:52:53.000Z (over 7 years ago)
- Last Synced: 2025-11-12T18:08:46.147Z (8 months ago)
- Topics: changelog, history, markdown, parser
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
Awesome Lists containing this project
README
# git-changelog-parser
Parse Git `ChangeLog.md / History.md` to JSON
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![NPM download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/git-changelog-parser.svg?style=flat-square
[npm-url]: https://npmjs.org/package/git-changelog-parser
[travis-image]: https://img.shields.io/travis/atian25/git-changelog-parser.svg?style=flat-square
[travis-url]: https://travis-ci.org/atian25/git-changelog-parser
[codecov-image]: https://codecov.io/gh/atian25/git-changelog-parser/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/atian25/git-changelog-parser
[david-image]: https://img.shields.io/david/atian25/git-changelog-parser.svg?style=flat-square
[david-url]: https://david-dm.org/atian25/git-changelog-parser
[snyk-image]: https://snyk.io/test/npm/git-changelog-parser/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/git-changelog-parser
[download-image]: https://img.shields.io/npm/dm/git-changelog-parser.svg?style=flat-square
[download-url]: https://npmjs.org/package/git-changelog-parser
## Install
```bash
npm i git-changelog-parser --save
```
## Usage
```js
const parse = require('git-changelog-parser');
const result = parse(content);
console.log(result);
// [ { version, date, author, content, title, type, start, end }, ...]
```