luciano/diff2html
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Add docs about the input format

Browse source
This commit is contained in:
Rodrigo Fernandes 2021-07-09 22:27:06 +01:00
parent 239d943fad
commit 9987e7c695
No known key found for this signature in database
GPG key ID: F44EAFEEB15615CB
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -26,6 +26,7 @@ diff2html generates pretty HTML diffs from git diff or unified diff output.
- [Online Example](#online-example) - [Online Example](#online-example)
- [Distributions](#distributions) - [Distributions](#distributions)
- [Usage](#usage) - [Usage](#usage)
- [Diff Text Input](#diff-text-input)
- [Diff2HtmlUI Usage](#diff2htmlui-usage) - [Diff2HtmlUI Usage](#diff2htmlui-usage)
- [Diff2HtmlUI API](#diff2htmlui-api) - [Diff2HtmlUI API](#diff2htmlui-api)
- [Diff2HtmlUI Configuration](#diff2htmlui-configuration) - [Diff2HtmlUI Configuration](#diff2htmlui-configuration)
@ -118,6 +119,13 @@ Diff2Html can be used in various ways as listed in the [distributions](#distribu
Bellow you can find more details and examples about each option. Bellow you can find more details and examples about each option.
## Diff Text Input
diff2html accepts the text contents of a
[unified diff](https://www.gnu.org/software/diffutils/manual/html_node/Unified-Format.html) or the superset format git
diff (https://git-scm.com/docs/git-diff) (not combined or word diff). To provide multiples files as input just
concatenate the diffs (just like the output of git diff).
## Diff2HtmlUI Usage ## Diff2HtmlUI Usage
> Simple wrapper to ease simple tasks in the browser such as: code highlight and js effects > Simple wrapper to ease simple tasks in the browser such as: code highlight and js effects