From 7cb2fc58467c851665684fa5e6f35f584d3de02a Mon Sep 17 00:00:00 2001 From: daniel-dx Date: Fri, 1 Mar 2019 22:37:30 +0800 Subject: [PATCH 1/4] docs(README): perfect readme --- README.md | 32 ++++++++++++++++++++++++++------ README_CN.md | 30 +++++++++++++++++++++++++----- 2 files changed, 51 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a228922..1f3ff57 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,30 @@ [中文版](README_CN.md) -ncform, a pleasing form development method that generates form UIs and their interactions with just configuration. - ![preview](docs/images/preview.png) +ncform, a nice form development way that generates form UIs and their interactions with just configuration. + +Comes with **standard components** and **validation rules**, out of the box. + +Have powerful **control interaction** and **extension capabilities**, do what you want. + +--- + +- Table Of Contents + - [Playground](#Playground) + - [Quick Start](#Quick-Start) + - [In node.js](#In-node.js) + - [In browser](#In-browser) + - [Features](#Features) + - [Documents](#Documents) + - [Solve Pain Points](#Solve-Pain-Points) + - [Repeat the wheel?](#Repeat-the-wheel?) + - [Why not use the standard json-schema?](#Why-not-use-the-standard-json-schema?) + - [dx expression](#dx-expression) + - [Design Thinking](#Design-Thinking) + - [Schema Generator](#Schema-Generator) + ## Playground Experience the charm of ncform on the [Playground](https://ncform.github.io/ncform/ncform-show/playground/index.html) to deepen your understanding of ncform @@ -78,7 +98,7 @@ export default { ``` You can refer to the [ncform-demo](https://github.com/daniel-dx/ncform-demo) project -### In a browser +### In browser ``` @@ -148,11 +168,11 @@ You can refer to the [ncform-demo](https://github.com/daniel-dx/ncform-demo) pro ## Documents -- [ncform config/props/api/event](./CONFIG.md) +- [ncform config / props / api / event](./CONFIG.md) -- [Standard Components](./STD-COMP.md) +- Standard Components [Preview Version](https://ncform.github.io/ncform/ncform-theme-elementui/index.html) | [Text Version](./STD-COMP.md) -- [How to extend](./EXT-DOC.md) +- [Custom Form Controls And Validation Rules](./EXT-DOC.md) ## Solve Pain Points diff --git a/README_CN.md b/README_CN.md index 5113123..e9c431a 100644 --- a/README_CN.md +++ b/README_CN.md @@ -4,9 +4,29 @@ [English Version](README.md) +![preview](docs/images/preview.png) + ncform，一种令人愉悦的表单开发方式，仅需配置即可生成表单UI及其交互行为。 -![preview](docs/images/preview.png) +自带丰富的 **标准组件** 和 **校验规则**，开箱即用。 + +具备强大的 **控件交互** 和 **扩展能力**，做你所想。 + +--- + +- 目录 + - [Playground](#Playground) + - [Quick Start](#Quick-Start) + - [In node.js](#In-node.js) + - [In browser](#In-browser) + - [特性](#特性) + - [文档](#文档) + - [解决痛点](#解决痛点) + - [重复造轮子？](#重复造轮子？) + - [为什么不用标准的json-schema？](#为什么不用标准的json-schema？) + - [dx表达式](#dx表达式) + - [设计思想](#设计思想) + - [Schema Generator](#Schema-Generator) ## Playground @@ -78,7 +98,7 @@ export default { ``` 可参考[ncform-demo](https://github.com/daniel-dx/ncform-demo)项目 -### In a browser +### In browser ``` @@ -148,11 +168,11 @@ export default { ## 文档 -- [ncform config/props/api/event](./CONFIG.md) +- [ncform config / props / api / event](./CONFIG.md) -- [Standard Components](./STD-COMP_CN.md) +- [标准组件预览版本](https://ncform.github.io/ncform/ncform-theme-elementui/index.html) / [标准组件文字版](./STD-COMP_CN.md) -- [How to extend](./EXT-DOC.md) +- [如何扩展 表单控件 / 校验规则](./EXT-DOC.md) ## 解决痛点 From c941a1a22a3ca129ca6c0c2404815680a911be8e Mon Sep 17 00:00:00 2001 From: daniel-dx Date: Fri, 1 Mar 2019 22:43:35 +0800 Subject: [PATCH 2/4] docs(README): perfect readme --- README.md | 6 +++--- README_CN.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1f3ff57..341572f 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,13 @@ Have powerful **control interaction** and **extension capabilities**, do what yo - Table Of Contents - [Playground](#Playground) - [Quick Start](#Quick-Start) - - [In node.js](#In-node.js) + - [In node.js](#In-node) - [In browser](#In-browser) - [Features](#Features) - [Documents](#Documents) - [Solve Pain Points](#Solve-Pain-Points) - - [Repeat the wheel?](#Repeat-the-wheel?) - - [Why not use the standard json-schema?](#Why-not-use-the-standard-json-schema?) + - [Repeat the wheel?](#Repeat-the-wheel) + - [Why not use the standard json-schema?](#Why-not-use-the-standard-json-schema) - [dx expression](#dx-expression) - [Design Thinking](#Design-Thinking) - [Schema Generator](#Schema-Generator) diff --git a/README_CN.md b/README_CN.md index e9c431a..134bbac 100644 --- a/README_CN.md +++ b/README_CN.md @@ -17,13 +17,13 @@ ncform，一种令人愉悦的表单开发方式，仅需配置即可生成表 - 目录 - [Playground](#Playground) - [Quick Start](#Quick-Start) - - [In node.js](#In-node.js) + - [In node.js](#In-node) - [In browser](#In-browser) - [特性](#特性) - [文档](#文档) - [解决痛点](#解决痛点) - - [重复造轮子？](#重复造轮子？) - - [为什么不用标准的json-schema？](#为什么不用标准的json-schema？) + - [重复造轮子？](#重复造轮子) + - [为什么不用标准的json-schema？](#为什么不用标准的json-schema) - [dx表达式](#dx表达式) - [设计思想](#设计思想) - [Schema Generator](#Schema-Generator) From 014fddf1a8637e10b58a9c768f4c5ce16d770e60 Mon Sep 17 00:00:00 2001 From: daniel-dx Date: Fri, 1 Mar 2019 22:50:33 +0800 Subject: [PATCH 3/4] docs(readme): perfect readme --- README.md | 2 +- README_CN.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 341572f..30354c0 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Have powerful **control interaction** and **extension capabilities**, do what yo - Table Of Contents - [Playground](#Playground) - [Quick Start](#Quick-Start) - - [In node.js](#In-node) + - [In node.js](#In-nodejs) - [In browser](#In-browser) - [Features](#Features) - [Documents](#Documents) diff --git a/README_CN.md b/README_CN.md index 134bbac..8f47001 100644 --- a/README_CN.md +++ b/README_CN.md @@ -17,7 +17,7 @@ ncform，一种令人愉悦的表单开发方式，仅需配置即可生成表 - 目录 - [Playground](#Playground) - [Quick Start](#Quick-Start) - - [In node.js](#In-node) + - [In node.js](#In-nodejs) - [In browser](#In-browser) - [特性](#特性) - [文档](#文档) From 14c1770086c4628d0692a671c8194d61038dcaa8 Mon Sep 17 00:00:00 2001 From: daniel-dx Date: Fri, 1 Mar 2019 23:55:32 +0800 Subject: [PATCH 4/4] docs: perfect docs --- README.md | 2 +- README_CN.md | 2 +- package.json | 4 ++- packages/ncform-common/README.md | 2 +- packages/ncform-show/README.md | 2 +- .../src/components/playground/playground.html | 6 +++++ .../src/components/playground/playground.js | 6 +++-- .../src/components/schema-gen/schema-gen.html | 3 +++ packages/ncform-theme-elementui/README.md | 8 +++--- .../examples/index.html | 7 +++++- packages/ncform/README.md | 12 ++++++--- packages/ncform/README_CN.md | 25 +++++++++++++++++++ packages/ncform/package.json | 4 ++- 13 files changed, 67 insertions(+), 16 deletions(-) create mode 100644 packages/ncform/README_CN.md diff --git a/README.md b/README.md index 30354c0..7568188 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ncform -![vue 2.5](https://img.shields.io/badge/vue-2.5-green.svg) +![vue 2.x](https://img.shields.io/badge/vue-2.x-green.svg) [中文版](README_CN.md) diff --git a/README_CN.md b/README_CN.md index 8f47001..d462e91 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,6 +1,6 @@ # ncform -![vue 2.5](https://img.shields.io/badge/vue-2.5-green.svg) +![vue 2.x](https://img.shields.io/badge/vue-2.x-green.svg) [English Version](README.md) diff --git a/package.json b/package.json index d2a036f..062ff58 100644 --- a/package.json +++ b/package.json @@ -3,12 +3,14 @@ "private": true, "license": "MIT", "keywords": [ + "vue", "json", "form", "automatic", "json-schema", "ncform", - "generation" + "generator", + "configuration" ], "scripts": { "bootstrap": "lerna bootstrap", diff --git a/packages/ncform-common/README.md b/packages/ncform-common/README.md index 8525177..d58575a 100755 --- a/packages/ncform-common/README.md +++ b/packages/ncform-common/README.md @@ -1,4 +1,4 @@ # ncform-common -ncform的通用工具类 +ncform's general tools diff --git a/packages/ncform-show/README.md b/packages/ncform-show/README.md index b445f65..bbcd04a 100755 --- a/packages/ncform-show/README.md +++ b/packages/ncform-show/README.md @@ -1,6 +1,6 @@ ## ncform show -ncform秀的舞台，当前主要提供了Playground和Schema Generator +The stage of the ncform show, currently provides Playground and Schema Generator # How to dev diff --git a/packages/ncform-show/src/components/playground/playground.html b/packages/ncform-show/src/components/playground/playground.html index 668e430..85fcba1 100755 --- a/packages/ncform-show/src/components/playground/playground.html +++ b/packages/ncform-show/src/components/playground/playground.html @@ -1,6 +1,11 @@
+ + + + + {{i18n.template}}： @@ -14,6 +19,7 @@ English 中文 + {{i18n.moreComp}} diff --git a/packages/ncform-show/src/components/playground/playground.js b/packages/ncform-show/src/components/playground/playground.js index eb71b31..879c19f 100755 --- a/packages/ncform-show/src/components/playground/playground.js +++ b/packages/ncform-show/src/components/playground/playground.js @@ -32,13 +32,15 @@ export default { template: 'Template', genForm: 'Run', getData: 'Get Data', - notValidJSON: 'Not valid JSON data' + notValidJSON: 'Not valid JSON data', + moreComp: 'See more widgets' }, cn: { template: '模板', genForm: '生成表单', getData: '获取表单数据', - notValidJSON: '不是有效的JSON数据' + notValidJSON: '不是有效的JSON数据', + moreComp: '看看更多的组件' } }, ncformSchema: { diff --git a/packages/ncform-show/src/components/schema-gen/schema-gen.html b/packages/ncform-show/src/components/schema-gen/schema-gen.html index 190ceeb..55cc22a 100755 --- a/packages/ncform-show/src/components/schema-gen/schema-gen.html +++ b/packages/ncform-show/src/components/schema-gen/schema-gen.html @@ -1,5 +1,8 @@
+ + +

ncform schema generator

Click to generate
diff --git a/packages/ncform-theme-elementui/README.md b/packages/ncform-theme-elementui/README.md index 21e138d..2dda1a4 100755 --- a/packages/ncform-theme-elementui/README.md +++ b/packages/ncform-theme-elementui/README.md @@ -1,7 +1,7 @@ # ncform theme element-ui -![vue 2.5](https://img.shields.io/badge/vue-2.5-green.svg) -![element-ui 2.0](https://img.shields.io/badge/element-2.0-blue.svg) +![vue 2.x](https://img.shields.io/badge/vue-2.x-green.svg) +![element-ui 2.x](https://img.shields.io/badge/element-2.x-blue.svg) ncform theme widgets -> element-ui @@ -17,13 +17,13 @@ Step 2: start development npm run dev ``` -[可选]配合以下可使用依赖的`ncform-common`的最新代码 +[Optional] Use the following command to watch and depend on the latest code for `ncform-common` ``` cd ../ncform-common npm run watch-build ``` -[可选]配合以下可使用依赖的`ncform`的最新代码 +[Optional] Use the following command to watch and depend on the latest code for `ncform` ``` cd ../ncform npm run watch-build diff --git a/packages/ncform-theme-elementui/examples/index.html b/packages/ncform-theme-elementui/examples/index.html index 68b0630..a1e08c5 100755 --- a/packages/ncform-theme-elementui/examples/index.html +++ b/packages/ncform-theme-elementui/examples/index.html @@ -21,6 +21,10 @@

+ + + + ncform standard components
@@ -36,7 +40,7 @@

-
+
  • @@ -79,6 +83,7 @@ if (location.search.indexOf('lang=cn') >= 0) { this.$data.lang = 'cn'; } + this.$data.currentUrl = this.$data.controls[0].url + '?lang=' + this.$data.lang; }, data: { controls: [ diff --git a/packages/ncform/README.md b/packages/ncform/README.md index 6cc6e47..1655cab 100644 --- a/packages/ncform/README.md +++ b/packages/ncform/README.md @@ -1,8 +1,14 @@ # ncform -ncform，一种令人愉悦的表单开发方式，仅需配置即可生成表单UI及其交互行为。 +![ncform](https://github.com/ncform/ncform/raw/master/docs/images/preview.png) -更详细信息请访问官网：[https://github.com/ncform/ncform](https://github.com/ncform/ncform) +ncform, a nice form development way that generates form UIs and their interactions with just configuration. + +Comes with standard components and validation rules, out of the box. + +Have powerful control interaction and extension capabilities, do what you want. + +For more details, please visit the official website: [https://github.com/ncform/ncform](https://github.com/ncform/ncform) # How to dev @@ -16,7 +22,7 @@ Step 2: start development npm run dev ``` -[可选]配合以下可使用依赖的`ncform-common`的最新代码 +[Optional] Use the following command to watch and depend on the latest code for `ncform-common` ``` cd ../ncform-common npm run watch-build diff --git a/packages/ncform/README_CN.md b/packages/ncform/README_CN.md new file mode 100644 index 0000000..6cc6e47 --- /dev/null +++ b/packages/ncform/README_CN.md @@ -0,0 +1,25 @@ +# ncform + +ncform，一种令人愉悦的表单开发方式，仅需配置即可生成表单UI及其交互行为。 + +更详细信息请访问官网：[https://github.com/ncform/ncform](https://github.com/ncform/ncform) + +# How to dev + +Step 1: prepare the dependency nc libraries +```sh +cd ../../ && npm run build +``` + +Step 2: start development +```sh +npm run dev +``` + +[可选]配合以下可使用依赖的`ncform-common`的最新代码 +``` +cd ../ncform-common +npm run watch-build +``` + + diff --git a/packages/ncform/package.json b/packages/ncform/package.json index 5917956..55ae058 100755 --- a/packages/ncform/package.json +++ b/packages/ncform/package.json @@ -5,12 +5,14 @@ "author": "daniel.xiao", "main": "dist/vueNcform.min.js", "keywords": [ + "vue", "json", "form", "automatic", "json-schema", "ncform", - "generation" + "generator", + "configuration" ], "scripts": { "dev": "gulp dev",