Skip to content

Commit

Permalink
docs: adjust documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Barrior committed Jan 12, 2024
1 parent 32046f8 commit 6b8f604
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
## SchemaRender

[![npm version](https://img.shields.io/npm/v/@schema-render/core-react/latest)](https://www.npmjs.com/package/@schema-render/core-react)
[![Documentation Build](https://github.com/Barrior/schema-render/actions/workflows/docs.yml/badge.svg)](https://github.com/Barrior/schema-render/actions/workflows/docs.yml)
[![Testing](https://github.com/Barrior/schema-render/actions/workflows/testing.yml/badge.svg)](https://github.com/Barrior/schema-render/actions/workflows/testing.yml)
[![codecov](https://codecov.io/gh/Barrior/schema-render/graph/badge.svg?token=38DB2R33FD)](https://codecov.io/gh/Barrior/schema-render)
[![Dependencies](https://img.shields.io/badge/dependencies-none-brightgreen.svg)](https://www.npmjs.com/package/@schema-render/core-react)
[![npm version](https://img.shields.io/npm/v/@schema-render/core-react/latest)](https://www.npmjs.com/package/@schema-render/core-react)

`SchemaRender` 是一套 `默认简单`,但又追求 `灵活``可高定``好用的` 表单渲染解决方案,旨在沉淀解决常见表单案例的渲染库,与相关的通用组件,以提升研发效率。

内容目录:

- `Core`: 表单渲染库内核,通过一套简易的 JSON Schema 构建出一套表单,内核主要处理 Schema 协议、渲染器编排、逻辑联动、校验能力等,支持 SSR(Server-Side Rendering)。
- 特点:协议驱动、简洁易用、高可定制、轻量级零依赖
- 特点:协议驱动、简洁易用、高可定制、轻量级
- `FormRender`: 基于 Core + [Antd](https://ant.design) 封装的开箱即用的表单渲染库。
- `Search`:基于 FormRender 封装的开箱即用的条件搜索组件。
- `SearchTable`:基于 Search + Antd Table 封装的条件搜索表格(建设中)。
Expand All @@ -25,7 +24,7 @@
Table of Contents:

- `Core`: The core of the form rendering library, which builds a set of forms through a simple JSON Schema. The core mainly handles the Schema protocol, renderer arrangement, logical linkage, verification capabilities, etc., and supports SSR (Server-Side Rendering).
- Features: Protocol driven, easy to use, highly customizable, lightweight and zero dependency.
- Features: Protocol driven, easy to use, highly customizable, lightweight.
- `FormRender`: An out-of-the-box form rendering library based on Core + [Antd](https://ant.design).
- `Search`: out-of-the-box conditional search component based on FormRender.
- `SearchTable`: A conditional search table based on Search + Antd Table (under construction).
Expand Down
2 changes: 1 addition & 1 deletion examples/core-react/001-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ const FormRender = dynamic(() => import('@schema-render/form-render-react'), {
- `协议驱动`:通过编写一份简易的 JSON Schema 来实现内容的渲染,参考[快速上手](./002-quick-start.md)
- `简洁易用`:仁者见仁智者见智,笔者以为是比较言简意赅、易用的,如同内部源码一样,化繁为简,无必要不增实体。
- `高可定制`:通过配置与组装 layout、itemLayout、renderers 等可以按需实现一个贴合业务自身的渲染库,如 FormRender。
- `轻量级`零依赖,资源包大小仅 18.8k, gzip 6.9k
- `轻量级`:资源包大小仅 17.6k, gzip 6.5k
4 changes: 2 additions & 2 deletions examples/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SchemaRender
description: 一套更好用的表单渲染解决方案,协议驱动、简洁易用、高可定制、轻量级零依赖
description: 一套更好用的表单渲染解决方案,协议驱动、简洁易用、高可定制、轻量级
keywords: ['SchemaRender', 'Form Render']
hero:
title: SchemaRender
Expand All @@ -13,7 +13,7 @@ hero:
features:
- title: Core
emoji: 💎
description: 渲染内核:协议驱动、简洁易用、高可定制、轻量级零依赖(18.8k, gzip 6.9k
description: 渲染内核:协议驱动、简洁易用、高可定制、轻量级(17.6k, gzip 6.5k
link: /core-react/001-intro
- title: FormRender
emoji: 🚀
Expand Down

0 comments on commit 6b8f604

Please sign in to comment.