A gitbook plugin for showing the differences between the codes within markdown
- usage
{% diff method="diffJson" %}
```json
{
"name": "gitbook-plugin-simple-mind-map",
"version": "0.2.1",
"description": "A gitBook plugin for generating and exporting mind map within markdown"
}
```
```json
{
"name": "gitbook-plugin-diff",
"version": "0.2.1",
"description": "A gitbook plugin for showing the differences between the codes within markdown"
}
```
{% enddiff %}- 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"
}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"
}
}
}diff support method and options for generating diff block code.
Here is basic grammar in your markdown file :
{% diff %}
```
old code
```
```
new code
```
{% enddiff %}
And there are some examples :
diffs two blocks of text, comparing character by character.
Return
Returns a list of change objects (See below).
Option
ignoreCase:trueto ignore casing difference. Defaults tofalse.
Examples
- usage
set
method="diffChars"to callDiff.diffChars(oldStr, newStr[, options])method
{% diff method="diffChars" %}
```js
cat
```
```js
cap
```
{% enddiff %}- preview
ca
- t
+ pdiffs two blocks of text, comparing word by word, ignoring whitespace.
Return
Returns a list of change objects (See below).
Option
ignoreCase: Same as indiffChars.
Examples
- usage
set
method="diffWords"to callDiff.diffWords(oldStr, newStr[, options])method
{% diff method="diffWords" %}
```bash
beep boop
```
```bash
beep boob blah
```
{% enddiff %}- preview
beep
- boop
+ boob
+ blahdiffs 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 indiffWords.
Examples
- usage
set
method="diffWordsWithSpace"to callDiff.diffWordsWithSpace(oldStr, newStr[, options])method
{% diff method="diffWordsWithSpace" %}
```bash
beep boop
```
```bash
beep boob blah
```
{% enddiff %}- preview
beep
- boop
+ boob blahdiffs two blocks of text, comparing line by line.
Return
Returns a list of change objects (See below).
Option
ignoreWhitespace:trueto ignore leading and trailing whitespace. This is the same asdiffTrimmedLinesnewlineIsToken:trueto 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 ofdiffLinesanddiffLinesis better suited for patches and other computer friendly output.
Examples
- usage
set
method="diffLines"to callDiff.diffLines(oldStr, newStr[, options])method
{% diff method="diffLines",options={"newlineIsToken":true} %}
```bash
beep boop
the cat is palying with cap
what
```
```bash
beep boob blah
the cat is palying with cap
who
```
{% enddiff %}- preview
- beep boop
+ beep boob blah
the cat is palying with cap
- what
+ whodiffs 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 indiffLines.newlineIsToken: Same as indiffLines.
Examples
- usage
set
method="diffTrimmedLines"to callDiff.diffTrimmedLines(oldStr, newStr[, options])method
{% diff method="diffTrimmedLines",options={"newlineIsToken":true} %}
```bash
beep boop
the cat is palying with cap
what
```
```bash
beep boob blah
the cat is palying with cat
who
```
{% enddiff %}- preview
- beep boop
the cat is palying with cap
what
+ beep boob blah
the cat is palying with cat
whodiffs two blocks of text, comparing sentence by sentence.
Return
Returns a list of change objects (See below).
Examples
- usage
set
method="diffSentences"to callDiff.diffSentences(oldStr, newStr[, options])method
{% diff method="diffSentences" %}
```bash
beep boop
the cat is palying with cap
what
```
```bash
beep boob blah
the cat is palying with cat
who
```
{% enddiff %}- preview
- beep boop
the cat is palying with cap
what
+ beep boob blah
the cat is palying with cat
whodiffs 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 callDiff.diffJson(oldObj, newObj[, options])method
{% diff method="diffJson" %}
```json
{
"name": "gitbook-plugin-simple-mind-map",
"version": "0.2.1",
"description": "A gitBook plugin for generating and exporting mind map within markdown"
}
```
```json
{
"name": "gitbook-plugin-diff",
"version": "0.2.1",
"description": "A gitbook plugin for showing the differences between the codes within markdown"
}
```
{% enddiff %}- 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"
}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 callDiff.diffArrays(oldArr, newArr[, options])method
{% diff method="diffArrays" %}
```json
[
"Vue",
"Python",
"Java",
"flutter",
"springboot",
"docker",
"React",
"小程序"
]
```
```json
[
"Vuejs",
"Nodejs",
"Java",
"flutter",
"springboot",
"docker",
"React"
]
```
{% enddiff %}- preview
[
- Vue
- Python
+ Vuejs
+ Nodejs
Java
flutter
springboot
docker
React
- 小程序
]- Run
gitbook install. It will automatically installdiffgitbook plugin for your book. This is needed only once.
gitbook installor 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- Sample
book.jsonfile
{
"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.
- 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
👤 snowdreams1006
- Website: snowdreams1006.tech
- Github: @snowdreams1006
- Email: snowdreams1006@163.com
Contributions, issues and feature requests are welcome! Feel free to check issues page.
Give a Star if this project helped you!
Copyright © 2019 snowdreams1006.
This project is MIT licensed.