Skip to content

Commit c3d7f5d

Browse files
cloydlaucloydlau
committed
docs: puncutaion
1 parent 08eb3a0 commit c3d7f5d

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ English | [简体中文](./docs/README.zh-CN.md)
4141

4242
### Peer Dependencies
4343

44-
- `vue`
45-
- `vanilla-jsoneditor`: standalone bundle provided by [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor) (successor to [jsoneditor](https://github.com/josdejong/jsoneditor))
46-
- `@vue/composition-api`: only for Vue 2.6 or earlier
44+
- vue
45+
- vanilla-jsoneditor: Standalone bundle provided by [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor) (successor to [jsoneditor](https://github.com/josdejong/jsoneditor))
46+
- ~~@vue/composition-api~~: Only for Vue 2.6 or earlier
4747

4848
<br>
4949

@@ -123,7 +123,7 @@ createApp()
123123

124124
#### CDN + UMD
125125

126-
> ⚠ Not yet supported because `vanilla-jsoneditor` does not export UMD, please leave a message [here](https://github.com/josdejong/svelte-jsoneditor/discussions/196) if you need it.
126+
> ⚠ Not yet supported because vanilla-jsoneditor does not export UMD, please leave a message [here](https://github.com/josdejong/svelte-jsoneditor/discussions/196) if you need it.
127127
128128
```html
129129
<!DOCTYPE html>
@@ -235,7 +235,7 @@ Vue.use(JsonEditorVue, {
235235

236236
#### CDN + UMD
237237

238-
> ⚠ Not yet supported because `vanilla-jsoneditor` does not export UMD, please leave a message [here](https://github.com/josdejong/svelte-jsoneditor/discussions/196) if you need it.
238+
> ⚠ Not yet supported because vanilla-jsoneditor does not export UMD, please leave a message [here](https://github.com/josdejong/svelte-jsoneditor/discussions/196) if you need it.
239239
240240
```html
241241
<!DOCTYPE html>
@@ -365,7 +365,7 @@ Vue.use(JsonEditorVue, {
365365

366366
#### CDN + UMD
367367

368-
> ⚠ Not yet supported because `vanilla-jsoneditor` does not export UMD, please leave a message [here](https://github.com/josdejong/svelte-jsoneditor/discussions/196) if you need it.
368+
> ⚠ Not yet supported because vanilla-jsoneditor does not export UMD, please leave a message [here](https://github.com/josdejong/svelte-jsoneditor/discussions/196) if you need it.
369369
370370
```html
371371
<!DOCTYPE html>
@@ -757,12 +757,12 @@ module.exports = {
757757

758758
> ⚠ kebab-case is required for tag & prop name when using from CDN
759759
760-
### Binding value difference between 'svelte-jsoneditor' and 'json-editor-vue'
760+
### Binding value difference between svelte-jsoneditor and json-editor-vue
761761

762-
- 'svelte-jsoneditor': An object contains a stringified JSON or a parsed JSON, will do `JSON.parse` when passing as a stringified JSON.
763-
- 'json-editor-vue': JSON itself. What users see is what users get.
762+
- svelte-jsoneditor: An object contains a stringified JSON or a parsed JSON, will do `JSON.parse` when passing as a stringified JSON.
763+
- json-editor-vue: JSON itself. What users see is what users get.
764764

765-
If you prefer the behavior of 'svelte-jsoneditor':
765+
If you prefer the behavior of svelte-jsoneditor:
766766

767767
```html
768768
<JsonEditorVue
@@ -776,7 +776,7 @@ If you prefer the behavior of 'svelte-jsoneditor':
776776
777777
### Boolean properties
778778

779-
Including the boolean properties of 'svelte-jsoneditor' like `readOnly` with no value will imply `true`:
779+
Including the boolean properties of svelte-jsoneditor like `readOnly` with no value will imply `true`:
780780

781781
- ✔️ `<JsonEditorVue readOnly />`
782782

‎docs/README.zh-CN.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@
3939

4040
### 外置依赖
4141

42-
- `vue`
43-
- `vanilla-jsoneditor`：[svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor) ([jsoneditor](https://github.com/josdejong/jsoneditor) 的继任者) 提供的原生 JS 版本
44-
- `@vue/composition-api`：仅 Vue 2.6 或更早版本需要
42+
- vue
43+
- vanilla-jsoneditor：[svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor) ([jsoneditor](https://github.com/josdejong/jsoneditor) 的继任者) 提供的原生 JS 版本
44+
- ~~@vue/composition-api~~：仅 Vue 2.6 或更早版本需要
4545

4646
<br>
4747

@@ -121,7 +121,7 @@ createApp()
121121

122122
#### CDN + UMD
123123

124-
> ⚠ 暂不支持 (`vanilla-jsoneditor` 不提供 UMD 导出)，如有需要请在[这里](https://github.com/josdejong/svelte-jsoneditor/discussions/196)留言。
124+
> ⚠ 暂不支持 (vanilla-jsoneditor 不提供 UMD 导出)，如有需要请在[这里](https://github.com/josdejong/svelte-jsoneditor/discussions/196)留言。
125125
126126
```html
127127
<!DOCTYPE html>
@@ -233,7 +233,7 @@ Vue.use(JsonEditorVue, {
233233

234234
#### CDN + UMD
235235

236-
> ⚠ 暂不支持 (`vanilla-jsoneditor` 不提供 UMD 导出)，如有需要请在[这里](https://github.com/josdejong/svelte-jsoneditor/discussions/196)留言。
236+
> ⚠ 暂不支持 (vanilla-jsoneditor 不提供 UMD 导出)，如有需要请在[这里](https://github.com/josdejong/svelte-jsoneditor/discussions/196)留言。
237237
238238
```html
239239
<!DOCTYPE html>
@@ -363,7 +363,7 @@ Vue.use(JsonEditorVue, {
363363

364364
#### CDN + UMD
365365

366-
> ⚠ 暂不支持 (`vanilla-jsoneditor` 不提供 UMD 导出)，如有需要请在[这里](https://github.com/josdejong/svelte-jsoneditor/discussions/196)留言。
366+
> ⚠ 暂不支持 (vanilla-jsoneditor 不提供 UMD 导出)，如有需要请在[这里](https://github.com/josdejong/svelte-jsoneditor/discussions/196)留言。
367367
368368
```html
369369
<!DOCTYPE html>
@@ -753,12 +753,12 @@ module.exports = {
753753
| mode | 编辑模式，<br>在 Vue 3 中使用 `[v-model]:mode`，<br>在 Vue 2 中使用 `:mode[.sync]` | [Mode](#Mode) | `'tree'` |
754754
| ... | [svelte-jsoneditor](https://github.com/josdejong/svelte-jsoneditor/#properties) 的参数（通过 attrs） | | |
755755

756-
### 'svelte-jsoneditor' 与 'json-editor-vue' 中绑定值的差异
756+
### svelte-jsoneditor 与 json-editor-vue 中绑定值的差异
757757

758-
- 'svelte-jsoneditor'：一个包含 “stringified JSON” 或 “parsed JSON” 的对象，当作为 “stringified JSON” 传入时，会经过 `JSON.parse` 解析。
759-
- 'json-editor-vue'：JSON 本身，所见即所得。
758+
- svelte-jsoneditor：一个包含 “stringified JSON” 或 “parsed JSON” 的对象，当作为 “stringified JSON” 传入时，会经过 `JSON.parse` 解析。
759+
- json-editor-vue：JSON 本身，所见即所得。
760760

761-
如果你更倾向于 'svelte-jsoneditor' 的行为：
761+
如果你更倾向于 svelte-jsoneditor 的行为：
762762

763763
```html
764764
<JsonEditorVue
@@ -772,7 +772,7 @@ module.exports = {
772772
773773
### 布尔类型参数
774774

775-
仅写上 'svelte-jsoneditor' 的布尔类型参数如 `readOnly` 但不传值，会隐式转换为 `true`：
775+
仅写上 svelte-jsoneditor 的布尔类型参数如 `readOnly` 但不传值，会隐式转换为 `true`：
776776

777777
- ✔️ `<JsonEditorVue readOnly />`
778778

0 commit comments

Comments
 (0)