Skip to content

Commit ecf05d3

Browse files
Shimada666Shimada666
committed
docs: move changelog to separate file and remove license from README
1 parent 702816b commit ecf05d3

3 files changed

Lines changed: 88 additions & 216 deletions

File tree

‎README-zh.md‎

Lines changed: 1 addition & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@
3030
- [组件属性](#组件属性)
3131
- [拓展高亮语言](#拓展高亮语言)
3232
- [从 0.x 版本迁移](#从-0x-版本迁移)
33-
- [变更记录](#变更记录)
34-
- [LICENSE](#licence)
3533

3634
## 安装
3735

@@ -184,108 +182,4 @@ v-code-diff 的 1.x 版本相较于 0.x 版本，具有打包体积减小、性
184182
| fileName | 文件名 | 1.x 版本更名为 filename |
185183
| isShowNoChange | 当无对比时展示源代码 | 1.x 变为默认情况，故移除 |
186184
| trim | 移除字符串前后空白字符 | 无 |
187-
| noDiffLineFeed | 忽视不同系统换行符差异 | 无 |
188-
189-
## 变更记录
190-
191-
### 1.0.0
192-
193-
重构后第一版
194-
195-
1. 移除 diff2html 依赖，自行绘制 ui。由于摆脱了 diff2html 依赖，解决了之前很多样式问题
196-
2. 更准确的语法高亮，更快的高亮速度
197-
198-
### 0.3.12
199-
200-
1. 撤销 prop `syncScroll` 因为有 bug。现在默认开启同步滚动
201-
202-
### 0.3.11
203-
204-
1. 增加 prop `syncScroll` 用于控制横向滚动条是否同步滚动
205-
206-
### 0.3.10
207-
208-
1. 修复了导出时的类型错误
209-
210-
### 0.3.9
211-
212-
1. 调整 css，让引入的 highlight.js 的样式只在 .d2h-wrapper 内生效
213-
214-
### 0.3.8
215-
216-
1. 样式调整，隐藏 css `d2h-file-header`，对齐 vue-code-diff
217-
2. 添加 prop `noDiffLineFeed`，不 diff windows 换行符(CRLF)与 linux 换行符(LF)
218-
219-
### 0.3.7
220-
221-
1. 修复当 isShowNoChange 为 true 时，而新旧代码不同时仍展示 “File Without Change” 的问题。然后展示全部源代码
222-
223-
### 0.3.6
224-
225-
1. 添加 prop `language`，能让高亮更准确
226-
227-
### 0.3.5
228-
229-
1. side-by-side 模式中，支持左右同步滚动
230-
231-
### 0.3.4
232-
233-
1. 增加 Prop `trim`, 可以移除字符串前后空白字符
234-
235-
### 0.3.3
236-
237-
1. 修复了 highlight 失效的问题
238-
239-
### 0.3.2
240-
241-
1. 修复了 vue2 用户的控制台警告
242-
243-
### 0.3.1
244-
245-
1. 修复了 diff 时样式显示 bug
246-
247-
### 0.3.0
248-
249-
1. 性能优化，现在渲染拥有更好的性能
250-
2. 添加 Prop `diffStyle` 来控制是否显示单词级差异还是字母级差异
251-
252-
### 0.2.1
253-
254-
1. 使用异步渲染高亮代码的功能，不阻塞 ui，极大提升页面渲染速度
255-
2. 增加钩子函数(渲染前，渲染后): `before-render`, `after-render`
256-
257-
### 0.1.0
258-
259-
1. 添加 Prop `highlight` 来控制是否高亮代码
260-
261-
### 0.0.4
262-
263-
1. 修复一些浏览器下渲染异常的问题（例如 safari）
264-
265-
### 0.0.3
266-
267-
1. Prop: `context` 默认值由 5 改为 10
268-
2. 修复可能存在的 line-height 冲突 (如 [antd-vue](https://github.com/vueComponent/ant-design-vue) 的 `antd.css` )
269-
270-
### 0.0.1
271-
272-
第一个版本.
273-
274-
## LICENCE
275-
276-
MIT License
277-
278-
Copyright (c) 2021 Shimada666
279-
280-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
281-
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
282-
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
283-
persons to whom the Software is furnished to do so, subject to the following conditions:
284-
285-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
286-
Software.
287-
288-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
289-
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
290-
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
291-
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
185+
| noDiffLineFeed | 忽视不同系统换行符差异 | 无 |

‎README.md‎

Lines changed: 1 addition & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ This project references the following projects, and I would like to express my g
3030
- [Props](#Props)
3131
- [Extend languages](#extend-languages)
3232
- [Migrate from 0.x version](#Migrate-from-0x-version)
33-
- [Changelog](#Changelog)
34-
- [LICENSE](#licence)
3533

3634
## Install
3735

@@ -190,110 +188,4 @@ simultaneously.
190188
| fileName | File name | To be determined, not under development |
191189
| isShowNoChange | Display source code when there is no comparison | Removed as it became the default in version 1.x |
192190
| trim | Remove blank characters at the beginning and end of the string | None |
193-
| noDiffLineFeed | Don't diff Windows line feed (CRLF) and Linux line feed (LF) | None |
194-
195-
## ChangeLog
196-
197-
### 1.0.0-alpha.0
198-
199-
1. Remove the diff2html dependency and draw the UI by self. By getting rid of the diff2html dependency, many styling
200-
problems have been resolved.
201-
2. More accurate syntax highlighting and faster highlighting speed.
202-
203-
### 0.3.12
204-
205-
1. Remove prop `syncScroll` due to bug. Synchronized scrolling is now enabled by default
206-
207-
### 0.3.11
208-
209-
1. Add prop `syncScroll` to control whether the horizontal scroll bar needs to be scrolled synchronously
210-
211-
### 0.3.10
212-
213-
1. Fixed type error when exporting
214-
215-
### 0.3.9
216-
217-
1. Make the imported highlight.js style take effect only in `.d2h-wrapper` div
218-
219-
### 0.3.8
220-
221-
1. Style adjustment, hide css `d2h-file-header`, same as vue-code-diff
222-
2. Add prop `noDiffLineFeed`, do not diff windows line feed (CRLF) and linux line feed (LF)
223-
224-
### 0.3.7
225-
226-
1. Fix the problem of displaying "File Without Change..." when isShowNoChange is true and the old and new codes are
227-
different,
228-
then show all the source code
229-
230-
### 0.3.6
231-
232-
1. Add prop `language`, make highlighting more accurate
233-
234-
### 0.3.5
235-
236-
1. In the side-by-side mode, support left and right synchronous scrolling
237-
238-
### 0.3.4
239-
240-
1. Add Prop `trim`, it will remove the blank characters before and after the string
241-
242-
### 0.3.3
243-
244-
1. Fixed the problem of highlight failure.
245-
246-
### 0.3.2
247-
248-
1. Fixed the warning for vue2 users in console
249-
250-
### 0.3.1
251-
252-
1. Fix incorrect style when comparing text
253-
254-
### 0.3.0
255-
256-
1. Performance optimization, now rendering has better performance
257-
2. Add Prop `diffStyle` to control whether to display word-level differences or char-level differences
258-
259-
### 0.2.1
260-
261-
1. Use the function of asynchronous rendering of the highlight code, without blocking the ui, greatly improving the page
262-
rendering speed
263-
2. Add hook function (before rendering, after rendering): `before-render`, `after-render`
264-
265-
### 0.1.0
266-
267-
1. Add prop `highlight` to control whether to highlight the code.
268-
269-
### 0.0.4
270-
271-
1. Fix the problem of abnormal rendering in some browsers (such as safari)
272-
273-
### 0.0.3
274-
275-
1. Prop: `context` default value changed from 5 to 10
276-
2. fix possible line-height conflict(such as `antd.css` in [antd-vue](https://github.com/vueComponent/ant-design-vue))
277-
278-
### 0.0.1
279-
280-
First Version.
281-
282-
## LICENCE
283-
284-
MIT License
285-
286-
Copyright (c) 2021 Shimada666
287-
288-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
289-
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
290-
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
291-
persons to whom the Software is furnished to do so, subject to the following conditions:
292-
293-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
294-
Software.
295-
296-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
297-
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
298-
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
299-
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
191+
| noDiffLineFeed | Don't diff Windows line feed (CRLF) and Linux line feed (LF) | None |

‎changelog-history.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
## ChangeLog
2+
3+
### 1.0.0-alpha.0
4+
5+
1. Remove the diff2html dependency and draw the UI by self. By getting rid of the diff2html dependency, many styling
6+
problems have been resolved.
7+
2. More accurate syntax highlighting and faster highlighting speed.
8+
9+
### 0.3.12
10+
11+
1. Remove prop `syncScroll` due to bug. Synchronized scrolling is now enabled by default
12+
13+
### 0.3.11
14+
15+
1. Add prop `syncScroll` to control whether the horizontal scroll bar needs to be scrolled synchronously
16+
17+
### 0.3.10
18+
19+
1. Fixed type error when exporting
20+
21+
### 0.3.9
22+
23+
1. Make the imported highlight.js style take effect only in `.d2h-wrapper` div
24+
25+
### 0.3.8
26+
27+
1. Style adjustment, hide css `d2h-file-header`, same as vue-code-diff
28+
2. Add prop `noDiffLineFeed`, do not diff windows line feed (CRLF) and linux line feed (LF)
29+
30+
### 0.3.7
31+
32+
1. Fix the problem of displaying "File Without Change..." when isShowNoChange is true and the old and new codes are
33+
different,
34+
then show all the source code
35+
36+
### 0.3.6
37+
38+
1. Add prop `language`, make highlighting more accurate
39+
40+
### 0.3.5
41+
42+
1. In the side-by-side mode, support left and right synchronous scrolling
43+
44+
### 0.3.4
45+
46+
1. Add Prop `trim`, it will remove the blank characters before and after the string
47+
48+
### 0.3.3
49+
50+
1. Fixed the problem of highlight failure.
51+
52+
### 0.3.2
53+
54+
1. Fixed the warning for vue2 users in console
55+
56+
### 0.3.1
57+
58+
1. Fix incorrect style when comparing text
59+
60+
### 0.3.0
61+
62+
1. Performance optimization, now rendering has better performance
63+
2. Add Prop `diffStyle` to control whether to display word-level differences or char-level differences
64+
65+
### 0.2.1
66+
67+
1. Use the function of asynchronous rendering of the highlight code, without blocking the ui, greatly improving the page
68+
rendering speed
69+
2. Add hook function (before rendering, after rendering): `before-render`, `after-render`
70+
71+
### 0.1.0
72+
73+
1. Add prop `highlight` to control whether to highlight the code.
74+
75+
### 0.0.4
76+
77+
1. Fix the problem of abnormal rendering in some browsers (such as safari)
78+
79+
### 0.0.3
80+
81+
1. Prop: `context` default value changed from 5 to 10
82+
2. fix possible line-height conflict(such as `antd.css` in [antd-vue](https://github.com/vueComponent/ant-design-vue))
83+
84+
### 0.0.1
85+
86+
First Version.

0 commit comments

Comments
 (0)