diff2html/README.md
Rodrigo Fernandes fde1df3a6a update README
2014-08-30 23:33:12 +01:00

49 lines
1 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 diff (not side-by-side)
* char-by-char highlight
* new and old line numbers
* inserted and removed lines
* GitHub like style
## Setup
Import the diff2html.js in your html.
> Pretty Html From Git Word Diff Output
Diff2Html.getPrettyHtmlFromDiff(exInput);
> Intermediate Json From Git Word Diff Output
Diff2Html.getJsonFromDiff(exInput);
> Pretty Html From Json
Diff2Html.getPrettyHtmlFromJson(exInput);
> Check out the `template.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).
---