Skip to content

Commit 23bd124

Browse files
committed
添加文档说明及demo地址
1 parent a1bbe3c commit 23bd124

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

2018-06-01.png

86.8 KB
Loading

README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# [vue-code-diff](https://www.npmjs.com/package/vue-code-diff)
22

3-
> 代码比对展示
3+
> 代码比对展示 [demo](http://diff.xjie.me/)
44
5-
## 安装
5+
## 安装
66
```shell
77
yarn add vue-code-diff
88
```
99

10-
## 使用
10+
## 使用
1111
```vue
1212
<template>
1313
<div>
@@ -27,18 +27,23 @@ export default {
2727
}
2828
```
2929

30-
## 参数说明
30+
## 参数说明
3131

3232
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
3333
|---------- |-------- |---------- |------------- |-------- |
3434
| old-string| 陈旧的字符串| string |||
3535
| new-string| 新的字符串| string |||
3636
| context| 不同地方上下间隔多少行不隐藏 | number |||
37+
| outputFormat| 展示的方式 | string | line-by-line,side-by-side | line-by-line |
3738

3839

3940
## 效果展示
4041

42+
### line-by-line
43+
![image](https://github.com/ddchef/vue-code-diff/blob/master/2018-06-01.png?raw=true)
44+
45+
### side-by-side
4146
![image](https://github.com/ddchef/vue-code-diff/blob/master/2018050615272.png?raw=true)
4247

4348
## LICENSE
44-
[MIT](LICENSE)
49+
[MIT](LICENSE)

0 commit comments

Comments
 (0)