Skip to content

Commit 18f778d

Browse files
cloydlaucloydlau
committed
docs: reduce the menu nesting level
1 parent 0d2f489 commit 18f778d

File tree

2 files changed

+28
-38
lines changed

2 files changed

+28
-38
lines changed

‎README.md‎

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ English | [简体中文](./docs/README.zh-CN.md)
3737
### Peer Dependencies
3838

3939
- `vue`
40-
- `vanilla-jsoneditor` standalone bundle provided by svelte-jsoneditor
41-
- `@vue/composition-api` only for Vue 2.6 or earlier
40+
- `vanilla-jsoneditor`: standalone bundle provided by `svelte-jsoneditor`
41+
- `@vue/composition-api`: only for Vue 2.6 or earlier
4242

4343
<br>
4444

@@ -75,9 +75,7 @@ createApp()
7575
.mount('#app')
7676
```
7777

78-
#### CDN
79-
80-
##### Using the ESM Build
78+
#### CDN + ESM
8179

8280
```html
8381
<!DOCTYPE html>
@@ -118,7 +116,7 @@ createApp()
118116
</html>
119117
```
120118

121-
##### Using the Global Build
119+
#### CDN + UMD
122120

123121
> ⚠ 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.
124122
@@ -187,9 +185,7 @@ Vue.use(JsonEditorVue, {
187185
})
188186
```
189187

190-
#### CDN
191-
192-
##### Using the ESM Build
188+
#### CDN + ESM
193189

194190
```html
195191
<!DOCTYPE html>
@@ -232,7 +228,7 @@ Vue.use(JsonEditorVue, {
232228
</html>
233229
```
234230

235-
##### Using the Global Build
231+
#### CDN + UMD
236232

237233
> ⚠ 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.
238234
@@ -314,9 +310,7 @@ Vue.use(JsonEditorVue, {
314310
})
315311
```
316312

317-
#### CDN
318-
319-
##### Using the ESM Build
313+
#### CDN + ESM
320314

321315
```html
322316
<!DOCTYPE html>
@@ -339,7 +333,7 @@ Vue.use(JsonEditorVue, {
339333
"imports": {
340334
"vue": "https://unpkg.com/vue@2.6/dist/vue.esm.browser.min.js",
341335
"@vue/composition-api": "https://unpkg.com/@vue/composition-api/dist/vue-composition-api.mjs",
342-
"@vue/composition-api/dist/vue-composition-api.mjs": "https://unpkg.com/@vue/composition-api/dist/ vue-composition-api.mjs",
336+
"@vue/composition-api/dist/vue-composition-api.mjs": "https://unpkg.com/@vue/composition-api/dist/vue-composition-api.mjs",
343337
"vue-demi": "https://unpkg.com/vue-demi/lib/v2/index.mjs",
344338
"vanilla-jsoneditor": "https://unpkg.com/vanilla-jsoneditor",
345339
"json-editor-vue": "https://unpkg.com/json-editor-vue@0.10/dist/json-editor-vue.mjs"
@@ -352,9 +346,10 @@ Vue.use(JsonEditorVue, {
352346
353347
const app = createApp({
354348
setup: () => ({
355-
value: ref()
356-
})
349+
value: ref(),
350+
}),
357351
})
352+
358353
app.use(JsonEditorVue)
359354
app.mount('#app')
360355
</script>
@@ -363,7 +358,7 @@ Vue.use(JsonEditorVue, {
363358
</html>
364359
```
365360

366-
##### Using the Global Build
361+
#### CDN + UMD
367362

368363
> ⚠ 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.
369364
@@ -670,8 +665,8 @@ export default {
670665
671666
### Binding value difference between `svelte-jsoneditor` and `json-editor-vue`
672667

673-
- `svelte-jsoneditor` An object contains a stringified JSON or a parsed JSON, will do `JSON.parse` when passing as a stringified JSON.
674-
- `json-editor-vue` JSON itself. What users see is what users get.
668+
- `svelte-jsoneditor`: An object contains a stringified JSON or a parsed JSON, will do `JSON.parse` when passing as a stringified JSON.
669+
- `json-editor-vue`: JSON itself. What users see is what users get.
675670

676671
If you prefer the behavior of `svelte-jsoneditor`:
677672

‎docs/README.zh-CN.md‎

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
### 外置依赖
3636

3737
- `vue`
38-
- `vanilla-jsoneditor` svelte-jsoneditor 提供的原生包
39-
- `@vue/composition-api` 仅 Vue 2.6 或更早版本需要
38+
- `vanilla-jsoneditor`: `svelte-jsoneditor` 提供的原生包
39+
- `@vue/composition-api`: 仅 Vue 2.6 或更早版本需要
4040

4141
<br>
4242

@@ -73,9 +73,7 @@ createApp()
7373
.mount('#app')
7474
```
7575

76-
#### CDN
77-
78-
##### 使用 ESM 构建版本
76+
#### CDN + ESM
7977

8078
```html
8179
<!DOCTYPE html>
@@ -116,7 +114,7 @@ createApp()
116114
</html>
117115
```
118116

119-
##### 使用全局构建版本
117+
#### CDN + UMD
120118

121119
> ⚠ 暂不支持（`vanilla-jsoneditor` 不提供 UMD 导出），如有需要请在[这里](https://github.com/josdejong/svelte-jsoneditor/discussions/196)留言。
122120
@@ -185,9 +183,7 @@ Vue.use(JsonEditorVue, {
185183
})
186184
```
187185

188-
#### CDN
189-
190-
##### 使用 ESM 构建版本
186+
#### CDN + ESM
191187

192188
```html
193189
<!DOCTYPE html>
@@ -230,7 +226,7 @@ Vue.use(JsonEditorVue, {
230226
</html>
231227
```
232228

233-
##### 使用全局构建版本
229+
#### CDN + UMD
234230

235231
> ⚠ 暂不支持（`vanilla-jsoneditor` 不提供 UMD 导出），如有需要请在[这里](https://github.com/josdejong/svelte-jsoneditor/discussions/196)留言。
236232
@@ -312,9 +308,7 @@ Vue.use(JsonEditorVue, {
312308
})
313309
```
314310

315-
#### CDN
316-
317-
##### 使用 ESM 构建版本
311+
#### CDN + ESM
318312

319313
```html
320314
<!DOCTYPE html>
@@ -337,7 +331,7 @@ Vue.use(JsonEditorVue, {
337331
"imports": {
338332
"vue": "https://unpkg.com/vue@2.6/dist/vue.esm.browser.min.js",
339333
"@vue/composition-api": "https://unpkg.com/@vue/composition-api/dist/vue-composition-api.mjs",
340-
"@vue/composition-api/dist/vue-composition-api.mjs": "https://unpkg.com/@vue/composition-api/dist/ vue-composition-api.mjs",
334+
"@vue/composition-api/dist/vue-composition-api.mjs": "https://unpkg.com/@vue/composition-api/dist/vue-composition-api.mjs",
341335
"vue-demi": "https://unpkg.com/vue-demi/lib/v2/index.mjs",
342336
"vanilla-jsoneditor": "https://unpkg.com/vanilla-jsoneditor",
343337
"json-editor-vue": "https://unpkg.com/json-editor-vue@0.10/dist/json-editor-vue.mjs"
@@ -350,9 +344,10 @@ Vue.use(JsonEditorVue, {
350344
351345
const app = createApp({
352346
setup: () => ({
353-
value: ref()
354-
})
347+
value: ref(),
348+
}),
355349
})
350+
356351
app.use(JsonEditorVue)
357352
app.mount('#app')
358353
</script>
@@ -361,7 +356,7 @@ Vue.use(JsonEditorVue, {
361356
</html>
362357
```
363358

364-
##### 使用全局构建版本
359+
#### CDN + UMD
365360

366361
> ⚠ 暂不支持（`vanilla-jsoneditor` 不提供 UMD 导出），如有需要请在[这里](https://github.com/josdejong/svelte-jsoneditor/discussions/196)留言。
367362
@@ -666,8 +661,8 @@ export default {
666661

667662
### `svelte-jsoneditor` 与 `json-editor-vue` 中绑定值的差异
668663

669-
- `svelte-jsoneditor` 一个包含「stringified JSON」或「parsed JSON」的对象，当作为「stringified JSON」传入时，会经过 `JSON.parse` 解析。
670-
- `json-editor-vue` JSON 本身，所见即所得。
664+
- `svelte-jsoneditor`: 一个包含「stringified JSON」或「parsed JSON」的对象，当作为「stringified JSON」传入时，会经过 `JSON.parse` 解析。
665+
- `json-editor-vue`: JSON 本身，所见即所得。
671666

672667
如果你更倾向于 `svelte-jsoneditor` 的行为：
673668

0 commit comments

Comments
 (0)