Skip to content

Commit 8c6ed5a

Browse files
authored
clean: Apply suggestions from code review
1 parent 78b9cb6 commit 8c6ed5a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,8 @@ The HTML output accepts a Javascript object with configuration. Possible options
314314

315315
- `outputFormat`: the format of the output data: `'line-by-line'` or `'side-by-side'`, default is `'line-by-line'`
316316
- `drawFileList`: show a file list before the diff: `true` or `false`, default is `true`
317-
- `srcPrefix`: add a prefix to all source (before changes) filepaths, default is `''`
318-
- `dstPrefix`: add a prefix to all destination (after changes) filepaths, default is `''`
317+
- `srcPrefix`: add a prefix to all source (before changes) filepaths, default is `''`. Should match the prefix used when [generating the diff](https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---src-prefixltprefixgt).
318+
- `dstPrefix`: add a prefix to all destination (after changes) filepaths, default is `''`. Should match the prefix used when [generating the diff](https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---dst-prefixltprefixgt)
319319
- `diffMaxChanges`: number of changed lines after which a file diff is deemed as too big and not displayed, default is
320320
`undefined`
321321
- `diffMaxLineLength`: number of characters in a diff line after which a file diff is deemed as too big and not
@@ -333,8 +333,8 @@ The HTML output accepts a Javascript object with configuration. Possible options
333333
`2500`
334334
- `maxLineSizeInBlockForComparison`: maximum number os characters of the bigger line in a block to apply comparison,
335335
default is `200`
336-
- `compiledTemplates`: object (Hogan template values) with previously compiled templates to replace parts of the html,
337-
default is `{}`
336+
- `compiledTemplates`: object ([Hogan.js](https://github.com/twitter/hogan.js/) template values) with previously compiled templates to replace parts of the html, default is `{}`.
337+
For example: `{ "tag-file-changed": Hogan.compile("<span class="d2h-tag d2h-changed d2h-changed-tag">MODIFIED</span>") }`
338338
- `rawTemplates`: object (string values) with raw not compiled templates to replace parts of the html, default is `{}`.
339339
For example: `{ "tag-file-changed": "<span class="d2h-tag d2h-changed d2h-changed-tag">MODIFIED</span>" }`
340340
> For more information regarding the possible templates look into

0 commit comments

Comments
 (0)