diff2html/README.md
2014-09-14 20:50:17 +01:00

67 lines
1.5 KiB
Markdown

# Diff to Html by [rtfpessoa](https://github.com/rtfpessoa)
Diff to Html generates pretty HTML diffs from git word diff output.
## Features
* `line-by-line` and `side-by-side` diff
* char-by-char highlight
* new and old line numbers
* inserted and removed lines
* GitHub like style
## Online Example
> Go to [Diff2HTML](http://rtfpessoa.github.io/diff2html/)
## Distributions
* [WebJar](http://www.webjars.org/)
* [Node Module](https://www.npmjs.org/package/diff2html)
* Manually download and import `diff2html.js` into your page
## How to use
> Pretty Line-by-Line Html From Git Word Diff Output
Diff2Html.getPrettyHtmlFromDiff(exInput)
> Pretty Side-by-Side Html From Git Word Diff Output
Diff2Html.getPrettySideBySideHtmlFromDiff(exInput)
> Intermediate Json From Git Word Diff Output
Diff2Html.getJsonFromDiff(exInput)
> Pretty Line-by-Line Html From Json
Diff2Html.getPrettyHtmlFromJson(exInput)
> Pretty Side-by-Side Html From Json
Diff2Html.getPrettySideBySideHtmlFromJson(exInput)
> Check out the `index.html` for a complete example.
## Contributions
All the contributions are welcome.
To contribute just send a pull request with your feature,fix,... and it will be reviewed asap.
## License
Copyright 2014 Rodrigo Fernandes. Released under the terms of the MIT license.
## Thanks
This project is inspired in [pretty-diff](https://github.com/scottgonzalez/pretty-diff) by [Scott González](https://github.com/scottgonzalez).
---