Skip to content

Commit 9987e7c

Browse files
committed
doc: Add docs about the input format
1 parent 239d943 commit 9987e7c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ diff2html generates pretty HTML diffs from git diff or unified diff output.
2626
- [Online Example](#online-example)
2727
- [Distributions](#distributions)
2828
- [Usage](#usage)
29+
- [Diff Text Input](#diff-text-input)
2930
- [Diff2HtmlUI Usage](#diff2htmlui-usage)
3031
- [Diff2HtmlUI API](#diff2htmlui-api)
3132
- [Diff2HtmlUI Configuration](#diff2htmlui-configuration)
@@ -118,6 +119,13 @@ Diff2Html can be used in various ways as listed in the [distributions](#distribu
118119

119120
Bellow you can find more details and examples about each option.
120121

122+
## Diff Text Input
123+
124+
diff2html accepts the text contents of a
125+
[unified diff](https://www.gnu.org/software/diffutils/manual/html_node/Unified-Format.html) or the superset format git
126+
diff (https://git-scm.com/docs/git-diff) (not combined or word diff). To provide multiples files as input just
127+
concatenate the diffs (just like the output of git diff).
128+
121129
## Diff2HtmlUI Usage
122130

123131
> Simple wrapper to ease simple tasks in the browser such as: code highlight and js effects

0 commit comments

Comments
 (0)