From 9987e7c69552717f253db760a03bae4de0697f56 Mon Sep 17 00:00:00 2001 From: Rodrigo Fernandes Date: Fri, 9 Jul 2021 22:27:06 +0100 Subject: [PATCH] doc: Add docs about the input format --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 2b15c9c..0a16c26 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ diff2html generates pretty HTML diffs from git diff or unified diff output. - [Online Example](#online-example) - [Distributions](#distributions) - [Usage](#usage) +- [Diff Text Input](#diff-text-input) - [Diff2HtmlUI Usage](#diff2htmlui-usage) - [Diff2HtmlUI API](#diff2htmlui-api) - [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. +## 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 > Simple wrapper to ease simple tasks in the browser such as: code highlight and js effects