Welcome to gitbook-plugin-diff 👋

A gitbook plugin for showing the differences between the codes within markdown

Screenshot

usage

{
-   "description": "A gitBook plugin for generating and exporting mind map within markdown",
-   "name": "gitbook-plugin-simple-mind-map",
+   "description": "A gitbook plugin for showing the differences between the codes within markdown",
+   "name": "gitbook-plugin-diff",
    "version": "0.2.1"
}

preview

{
-   "description": "A gitBook plugin for generating and exporting mind map within markdown",
-   "name": "gitbook-plugin-simple-mind-map",
+   "description": "A gitbook plugin for showing the differences between the codes within markdown",
+   "name": "gitbook-plugin-diff",
    "version": "0.2.1"
}

Usage

Step #1 - Update `book.json` file

In you gitbook's book.json file, add diff to plugins list.

Here is simplest example :

{
    "plugins": ["diff"]
}

In addition, the supported configuration options are as follows :

"gitbook": {
    "properties": {
        "type": {
            "type": "string",
            "title": "render type",
            "required": false,
            "default": "markdown",
            "description": "some supported methods such as markdown or console or html"
        },
        "method": {
            "type": "string",
            "title": "jsdiff api method",
            "required": false,
            "default": "diffChars",
            "description": "some supported methods such as diffChars or diffWords or diffWordsWithSpace or diffLines or diffTrimmedLines or diffSentences or diffJson or diffArrays"
        },
        "options": {
            "type": "object",
            "title": "jsdiff api options",
            "required": false,
            "description": "some methods may not support options"
        }
    }
}

Step #2 - Use in markdown file

diff support method and options for generating diff block code.

Here is basic grammar in your markdown file :

- old
+ new
   code

And there are some examples :

`Diff.diffChars(oldStr, newStr[, options])`

diffs two blocks of text, comparing character by character.

Return

Returns a list of change objects (See below).

Option

ignoreCase: true to ignore casing difference. Defaults to false.

Examples

usage

set method="diffChars" to call Diff.diffChars(oldStr, newStr[, options]) method

  ca
- t
+ p

preview

  ca
- t
+ p

`Diff.diffWords(oldStr, newStr[, options])`

diffs two blocks of text, comparing word by word, ignoring whitespace.

Return

Returns a list of change objects (See below).

Option

ignoreCase: Same as in diffChars.

Examples

usage

set method="diffWords" to call Diff.diffWords(oldStr, newStr[, options]) method

  beep 
- boop
+ boob

+ blah

preview

  beep 
- boop
+ boob

+ blah

`Diff.diffWordsWithSpace(oldStr, newStr[, options])`

diffs two blocks of text, comparing word by word, treating whitespace as significant.

Return

Returns a list of change objects (See below).

Option

ignoreCase: Same as in diffWords.

Examples

usage

set method="diffWordsWithSpace" to call Diff.diffWordsWithSpace(oldStr, newStr[, options]) method

  beep 
- boop  

+ boob blah

preview

  beep 
- boop
+ boob blah

`Diff.diffLines(oldStr, newStr[, options])`

diffs two blocks of text, comparing line by line.

Return

Returns a list of change objects (See below).

Option

ignoreWhitespace: true to ignore leading and trailing whitespace. This is the same as diffTrimmedLines
newlineIsToken: true to treat newline characters as separate tokens. This allows for changes to the newline structure to occur independently of the line content and to be treated as such. In general this is the more human friendly form of diffLines and diffLines is better suited for patches and other computer friendly output.

Examples

usage

set method="diffLines" to call Diff.diffLines(oldStr, newStr[, options]) method

- beep boop

+ beep boob blah

  the cat is palying with cap

- what

+ who

preview

- beep boop

+ beep boob blah

  the cat is palying with cap

- what

+ who

`Diff.diffTrimmedLines(oldStr, newStr[, options])`

diffs two blocks of text, comparing line by line, ignoring leading and trailing whitespace.

Return

Returns a list of change objects (See below).

Option

ignoreWhitespace: Same as in diffLines.
newlineIsToken: Same as in diffLines.

Examples

usage

set method="diffTrimmedLines" to call Diff.diffTrimmedLines(oldStr, newStr[, options]) method

- beep boop
- the cat is palying with cap
- what
+ beep boob blah
+ the cat is palying with cat
+ who

preview

- beep boop
  the cat is palying with cap
  what

+ beep boob blah
  the cat is palying with cat
  who

`Diff.diffSentences(oldStr, newStr[, options])`

diffs two blocks of text, comparing sentence by sentence.

Return

Returns a list of change objects (See below).

Examples

usage

set method="diffSentences" to call Diff.diffSentences(oldStr, newStr[, options]) method

- beep boop
- the cat is palying with cap
- what
+ beep boob blah
+ the cat is palying with cat
+ who

preview

- beep boop
  the cat is palying with cap
  what

+ beep boob blah
  the cat is palying with cat
  who

`Diff.diffJson(oldObj, newObj[, options])`

diffs two JSON objects, comparing the fields defined on each. The order of fields, etc does not matter in this comparison.

Return

Returns a list of change objects (See below).

Examples

usage

set method="diffJson" to call Diff.diffJson(oldObj, newObj[, options]) method

{
-   "description": "A gitBook plugin for generating and exporting mind map within markdown",
-   "name": "gitbook-plugin-simple-mind-map",
+   "description": "A gitbook plugin for showing the differences between the codes within markdown",
+   "name": "gitbook-plugin-diff",
    "version": "0.2.1"
}

preview

{
-   "description": "A gitBook plugin for generating and exporting mind map within markdown",
-   "name": "gitbook-plugin-simple-mind-map",
+   "description": "A gitbook plugin for showing the differences between the codes within markdown",
+   "name": "gitbook-plugin-diff",
    "version": "0.2.1"
}

`Diff.diffArrays(oldArr, newArr[, options])`

diffs two arrays, comparing each item for strict equality (===).

Return

Returns a list of change objects (See below).

Options

comparator: function(left, right) for custom equality checks

Examples

usage

set method="diffArrays" to call Diff.diffArrays(oldArr, newArr[, options]) method

[
- Vue
- Python
+ Vuejs
+ Nodejs
  Java
  flutter
  springboot
  docker
  React
- 小程序
]

preview

[
-   Vue
-   Python
+   Vuejs
+   Nodejs
    Java
    flutter
    springboot
    docker
    React
-   小程序
]

Step #3 - Run gitbook commands

Run gitbook install. It will automatically install diff gitbook plugin for your book. This is needed only once.

gitbook install

or you can run npm install gitbook-plugin-diff to install locally.

npm install gitbook-plugin-diff

Build your book (gitbook build) or serve (gitbook serve) as usual.

gitbook serve

Examples

Sample book.json file

{
    "plugins": ["diff"]
}

or you can set method as your default method to compare between codes:

{
    "plugins": ["diff"],
    "pluginsConfig": {
        "diff": {
            "method": "diffChars"
        }
    }
}

or you can set options as your default settings according to method:

{
    "plugins": ["diff"],
    "pluginsConfig": {
        "diff": {
            "method": "diffChars",
            "options": {
              "ignoreCase": true
            }
        }
    }
}

Note: Above snippet can be used as complete book.json file, if your book doesn't have one yet.

Thanks

A javascript text differencing implementation. : https://github.com/kpdecker/jsdiff
get colors in your node.js console : https://github.com/Marak/colors.js
GitBook CodeGroup Plugin : https://github.com/lwhiteley/gitbook-plugin-codegroup

Author

👤 snowdreams1006

Contributing

Contributions, issues and feature requests are welcome! Feel free to check issues page.

Show your support

Give a Star if this project helped you!

Copyright

This project is MIT licensed.

Author: snowdreams1006
Url: https://snowdreams1006.github.io/gitbook-plugin-diff/en/
Source: snowdreams1006.tech
This article was originally published in「snowdreams1006.tech」,Reproduced please indicate the source, thank you for cooperation!

Introduction

Welcome to gitbook-plugin-diff 👋

Screenshot

Usage

Step #1 - Update `book.json` file

Step #2 - Use in markdown file

`Diff.diffChars(oldStr, newStr[, options])`

`Diff.diffWords(oldStr, newStr[, options])`

`Diff.diffWordsWithSpace(oldStr, newStr[, options])`

`Diff.diffLines(oldStr, newStr[, options])`

`Diff.diffTrimmedLines(oldStr, newStr[, options])`

`Diff.diffSentences(oldStr, newStr[, options])`

`Diff.diffJson(oldObj, newObj[, options])`

`Diff.diffArrays(oldArr, newArr[, options])`

Step #3 - Run gitbook commands

Examples

Thanks

Author

Contributing

Show your support

Copyright

results matching ""

No results matching ""

Welcome to gitbook-plugin-diff 👋

Screenshot

Usage

Step #1 - Update book.json file

Step #2 - Use in markdown file

Diff.diffChars(oldStr, newStr[, options])

Diff.diffWords(oldStr, newStr[, options])

Diff.diffWordsWithSpace(oldStr, newStr[, options])

Diff.diffLines(oldStr, newStr[, options])

Diff.diffTrimmedLines(oldStr, newStr[, options])

Diff.diffSentences(oldStr, newStr[, options])

Diff.diffJson(oldObj, newObj[, options])

Diff.diffArrays(oldArr, newArr[, options])

Step #3 - Run gitbook commands

Examples

Thanks

Author

Contributing

Show your support

Copyright

results matching ""

No results matching ""

Step #1 - Update `book.json` file

`Diff.diffChars(oldStr, newStr[, options])`

`Diff.diffWords(oldStr, newStr[, options])`

`Diff.diffWordsWithSpace(oldStr, newStr[, options])`

`Diff.diffLines(oldStr, newStr[, options])`

`Diff.diffTrimmedLines(oldStr, newStr[, options])`

`Diff.diffSentences(oldStr, newStr[, options])`

`Diff.diffJson(oldObj, newObj[, options])`

`Diff.diffArrays(oldArr, newArr[, options])`