Skip to content

Commit 7c0c222

Browse files
committed
docs: 更新文档准确性
1 parent 6a00a30 commit 7c0c222

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+157
-3163
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# vue-json-schema-form
2-
基于 `Vue``ElementUi``Json Schema` 快速构建一个带完整校验的form表单.
2+
基于 `Vue``ElementUi``JSON Schema` 快速构建一个带完整校验的form表单.
33

44
## 快速体验
55
* [演示demo](https://form.lljj.me/ "Vue JSON Schema Form Demo")
@@ -81,7 +81,7 @@ yarn run demo:dev --dir=vue-editor
8181
```
8282

8383
### 说明
84-
* 遵循 `JSON Schema` 规范,只需要给定 `Json Schema`,即可生成对应的form表单
84+
* 遵循 `JSON Schema` 规范,只需要给定 `JSON Schema`,即可生成对应的form表单
8585
* 快速配置个性化ui视图和校验错误信息,可适配常用的ui库,目前的版本默认视图依赖 `elementUi`,后续版本会解耦开来,可通过配置适配ElementUi,iView 或者你自己开发的组件库等
8686
* 表单schema校验使用 [ajv](https://github.com/epoberezkin/ajv)
8787
* 设计思想和对schema解析索引参考 [react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form)
@@ -92,7 +92,7 @@ yarn run demo:dev --dir=vue-editor
9292
[Element Ui](https://element.eleme.io/)
9393

9494
### 为何开发
95-
原本是在很久前公司流产的项目类似淘宝店铺装修,也可以叫做前端可视化编辑。为了解决数据配置表单的通用性,所以使用 `Json Schema` 描述数据结构,动态生成表单。
95+
原本是在很久前公司流产的项目类似淘宝店铺装修,也可以叫做前端可视化编辑。为了解决数据配置表单的通用性,所以使用 `JSON Schema` 描述数据结构,动态生成表单。
9696

9797
这样做的好处除了解决在每个配置表单的重复工作,服务端也可以基于同一份schema保持和前端一致的校验规则,不过对于使用 vue elementUi并未找到合适库可以直接使用,所以在后面一段时间决定自己实现一个 。
9898

README_en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# vue-json-schema-form
2-
Quickly building HTML form based on `Vue`, `Json Schema` and `ElementUi`.
2+
Quickly building HTML form based on `Vue`, `JSON Schema` and `ElementUi`.
33

44
## Experience quickly
55
* [Live playground](https://form.lljj.me/ "Vue JSON Schema Form Demo")
@@ -80,7 +80,7 @@ yarn run demo:dev --dir=vue-editor
8080
```
8181

8282
### Description
83-
* Follow the JSON Schema specification, only need to give the `Json Schema`, you can generate the corresponding form
83+
* Follow the JSON Schema specification, only need to give the `JSON Schema`, you can generate the corresponding form
8484
* Quickly configure personalized UI views and check error messages, which can be adapted to commonly used UI libraries. The default view of the current version depends on `ElementUi`.
8585
* Uses the [ajv validator](https://github.com/epoberezkin/ajv)
8686
* Design ideas and reference to the schema analysis index [react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form)
@@ -91,7 +91,7 @@ yarn run demo:dev --dir=vue-editor
9191
[Element Ui](https://element.eleme.io/)
9292

9393
### Why
94-
Originated from shop decoration scenes, it can also be called front-end visual editing. In order to solve the universality of the component data configuration form, the form is generated through `Json Schema`.
94+
Originated from shop decoration scenes, it can also be called front-end visual editing. In order to solve the universality of the component data configuration form, the form is generated through `JSON Schema`.
9595

9696
The advantage of this is to solve the repetitive work of each configuration form, and the server can also maintain the same verification rules as the front-end based on the same schema.
9797

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"private": true,
3-
"description": "基于 Vue 、Json Schema快速构建一个带完整校验的form表单",
3+
"description": "基于 Vue 、JSON Schema 快速构建一个带完整校验的form表单",
44
"repository": "https://github.com/lljj-x/vue-json-schema-form",
55
"homepage": "https://github.com/lljj-x/vue-json-schema-form",
66
"author": "Liu.Jun",

packages/docs/docs/.vuepress/localesConfig/en.config.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module.exports = {
88
// 作为特例,默认语言可以使用 '/' 作为其路径。
99
lang: 'en-US',
1010
title: 'Vue JSON Schema Form',
11-
description: 'Quickly build a form with complete verification based on Vue and Json Schema'
11+
description: 'Quickly build a form with complete verification based on Vue and JSON Schema'
1212
},
1313
themeConfig: {
1414
// 多语言下拉菜单的标题
@@ -53,14 +53,14 @@ module.exports = {
5353
// 侧边栏
5454
// 省略 .md 拓展名,同时以 / 结尾的路径将会被视为 */README.md
5555
sidebar: {
56-
'/en/guide/': require('./genConfig').getGuideSidebar([
57-
'Guide',
58-
'Configuration',
59-
'Principle',
60-
'Update plan'
61-
]),
62-
'/en/config/': require('./genConfig').getConfigSidebar(),
63-
'/en/rules/': require('./genConfig').getRulesSidebar(),
56+
// '/en/guide/': require('./genConfig').getGuideSidebar([
57+
// 'Guide',
58+
// 'Configuration',
59+
// 'Principle',
60+
// 'Update plan'
61+
// ]),
62+
// '/en/config/': require('./genConfig').getConfigSidebar(),
63+
// '/en/rules/': require('./genConfig').getRulesSidebar(),
6464
}
6565
}
6666
}

packages/docs/docs/.vuepress/localesConfig/zh.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module.exports = {
88
// 作为特例,默认语言可以使用 '/' 作为其路径。
99
lang: 'zh-CN',
1010
title: 'Vue JSON Schema Form',
11-
description: '基于 Vue 、Json Schema快速构建一个带完整校验的form表单'
11+
description: '基于 Vue 、JSON Schema快速构建一个带完整校验的form表单'
1212
},
1313
themeConfig: {
1414
// 多语言下拉菜单的标题

packages/docs/docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ home: true
33
pageClass: custom-page-home
44
heroImage: /logo.png
55
heroText: Vue JSON Schema Form
6-
tagline: 基于 Vue 、Json Schema快速构建一个带完整校验的form表单
6+
tagline: 基于 Vue 、JSON Schema 快速构建一个带完整校验的form表单
77
footer: Apache2.0 Licensed | Copyright © 2020-2020 Jun
88
actionText: 快速开始 →
99
actionLink: /zh/guide/

packages/docs/docs/en/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ home: true
33
pageClass: custom-page-home
44
heroImage: /logo.png
55
heroText: Vue JSON Schema Form
6-
tagline: Quickly building HTML form based on Vue and Json Schema
6+
tagline: Quickly building HTML form based on Vue and JSON Schema
77
footer: Apache2.0 Licensed | Copyright © 2020-2020 Jun
8-
actionText: Quick start →
9-
actionLink: /en/guide/
8+
# actionText: Quick start →
9+
# actionLink: /en/guide/
1010
---
1111

1212
## Experience quickly

0 commit comments

Comments
 (0)