Skip to content

martijnvanduijneveldt/markdown-diff

Repository files navigation

markdown-diff

This module generates a difference between two markdown files while keeping renderable in a markdown format

WIP : feel free to open pull requests

Installation

Install with npm:

$ npm install markdown-diff --save

Install with yarn:

$ yarn add markdown-diff --save

Usage

  • Import
import { markdownDiff } from 'markdown-diff';
  • Usage
const res = markdownDiff('oldStr', 'newStr');

Example

Simple sentence

Simple sentence and delete
Simple sentence with insert and

Simple sentence with insert and delete

Lists

Before :
- ele one
- ele two
After  :
- ele one
- ele two
- ele three
  • ele one
  • ele two
  • ele three

TODO

  • Blockquote nested line
  • Espace token
  • Html token
  • Hr token
  • Tag token

License

MIT