docs: 修改文档和readme

JackySoft · Sep 13, 2024 · 58a0184 · 58a0184
1 parent 6fb872e
commit 58a0184
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 15 deletions.
diff --git a/.github/imgs/intro1.png b/.github/imgs/intro1.png
diff --git a/.github/imgs/intro2.png b/.github/imgs/intro2.png
diff --git a/.github/imgs/intro3.png b/.github/imgs/intro3.png
diff --git a/.github/imgs/intro4.png b/.github/imgs/intro4.png
diff --git a/.github/imgs/intro5.png b/.github/imgs/intro5.png
diff --git a/.github/imgs/intro6.png b/.github/imgs/intro6.png
diff --git a/.github/imgs/intro7.png b/.github/imgs/intro7.png
diff --git a/.github/imgs/intro8.png b/.github/imgs/intro8.png
diff --git a/.github/imgs/mars-logo.png b/.github/imgs/mars-logo.png
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <div align="center">
 
-<a href="http://marsview.cc/"><img src="/.github/imgs/mars-logo.png" width="120" height="120" alt="marsview logo"></a>
+<a href="http://marsview.cc/"><img src="/.github/imgs/logo.png" width="150" alt="marsview logo"></a>
 
 # Marsview 低代码平台
 
@@ -26,7 +26,7 @@
 
 ## 介绍 🚀
 
-Marsview 是一款中后台方向的低代码可视化搭建平台，开发者可以在平台上完成项目和页面的闭环，支持事件交互、接口调用、数据联动和逻辑编排等，开发者可通过微服务快速集成到自己的业务系统中。
+Marsview 是一款中后台方向的低代码可视化搭建平台，开发者可以在平台上创建项目、页面和组件，支持事件交互、接口调用、数据联动和逻辑编排等，开发者还可通过微服务快速集成到自己的业务系统中。
 
 ## 在线使用 🛸
 
@@ -37,19 +37,21 @@ Marsview 是一款中后台方向的低代码可视化搭建平台，开发者
 | ![Demo](./.github/imgs/intro1.png) | ![Demo](./.github/imgs/intro2.png) |
 | ![Demo](./.github/imgs/intro3.png) | ![Demo](./.github/imgs/intro4.png) |
 | ![Demo](./.github/imgs/intro5.png) | ![Demo](./.github/imgs/intro6.png) |
+| ![Demo](./.github/imgs/intro7.png) | ![Demo](./.github/imgs/intro8.png) |
 
 ## 特色 💥
 
 - **项目：**
-  项目创建、项目配置（主题色、菜单布局、系统 Logo、面包屑...）、项目菜单创建、项目角色创建、用户管理；
-  基于 RBAC 的权限管理。创建项目后，可以直接通过 [http://admin.marsview.cc](http://admin.marsview.cc) 去访问配置的项目。
-- **页面：** 页面创建、页面主题、页面配置、组件拖拽、组件属性、组件事件、组件数据。
-  目前完全可用于生产环境，项目在创建菜单时可以关联该页面。
-  页面同时支持其他传统系统通过微服务集成，不管你的系统是 Vue 还是 React。
-- **页面组件：** 目前支持的组件有：按钮、表单（所有表单组件）、表格、图表、弹窗、图片、富文本、文件上传、文件下载、代码编辑器、编辑表格、iframe 等常用的页面组件。表单支持了常用规则验证和自定义规则验证。
-- **自定义组件：** 自带页面组件满足不了需求时可以自定义开发相关组件，支持 jsx 语法，less 和事件。
-- **接口：** 接口、口创建、接口配置，支持 GET、POST、PUT、DELETE 等请求方式，支持接口参数传递。
-- **事件流：** 通过事件流可以完成高难度的业务逻辑编排，比如：组件联动、组件显隐、组件禁用、逻辑处理等。
+  项目配置（主题色、菜单布局、系统 Logo、面包屑...）、完整的 RBAC 的权限管理。
+- **页面：** 页面创建、页面主题、页面配置、组件拖拽、样式配置、事件流配置、逻辑编排、接口配置。
+  页面支持通过微服务的方式集成到传统项目中，无论你是 Vue 还是 React。
+- **权限：** 项目和页面支持开发者和访问者权限配置，项目还支持菜单、按钮级别的 RBAC 控制。
+- **自定义组件：** 当平台提供的组件满足不了需求时，可以自定义开发业务组件，平台会在线编译，上传到云端，同时在编辑器界面自定义组件中可以点击进行加载。
+- **接口：** 接口统一管理，全局拦截器、返回结构修改等。支持 GET、POST、PUT、DELETE 等请求方式，支持接口动态参数传递。
+- **事件流：** 通过事件流可以完成高难度的业务逻辑编排，比如：组件联动、组件显隐、组件禁用、自定义逻辑处理、接口调用、路由跳转等。
+- **环境：** 平台支持三套环境，STG、PRE 和 PRD，页面只有发布到对应环境后，才可以在用户端访问到该页面。
+- **回滚：** 平台发布后的页面支持一键回滚。
+- **微服务：** 如果你是传统的 Vue 项目，想使用此平台，可以先在平台搭建一个页面发布到 PRD 环境，最后通过微服务集成进来。
 
 ## 本地开发 👨‍💻
 
@@ -70,7 +72,7 @@ cd marsview
 pnpm i
 # 启动编辑器
 pnpm start:editor
-# 启动用户端
+# 启动用户端（用户端是当你页面搭建完成后，给用户提供独立访问的系统）
 pnpm start:admin
 ```
 

diff --git a/packages/docs/src/home.md b/packages/docs/src/home.md
@@ -1,6 +1,6 @@
 # Marsview 平台介绍
 
-Marsview 是一款中后台方向的低代码可视化搭建平台，开发者可以在平台上完成项目和页面的闭环，支持事件交互、接口调用、数据联动和逻辑编排等，开发者可通过微服务快速集成到自己的业务系统中。
+Marsview 是一款中后台方向的低代码可视化搭建平台，开发者可以在平台上创建项目、页面和组件，支持事件交互、接口调用、数据联动和逻辑编排等，开发者还可通过微服务快速集成到自己的业务系统中。
 
 ## 特性
 
@@ -12,8 +12,10 @@ Marsview 是一款中后台方向的低代码可视化搭建平台，开发者
 
 ## 项目和页面关系
 
-项目是主体，页面是内容载体，项目会包含多个页面。跟我们日常后台管理项目类似，我们日常开发会通过脚手架初始化一个项目，然后配置路由、封装`request`，封装组件、封装工具函数等。
+项目是主体，页面是内容载体，项目会包含多个页面，项目创建完以后可以通过`http://admin.marsview.cc`去访问，此时还需要给项目创建菜单并关联页面后，点击菜单才能打开，同时页面还必须是已经发布到对应环境的才可以。
 
-在`Marsview`中，我们不需要脚手架，不需要项目架构，只需要可视化创建项目，添加基础配置即可。当项目创建好以后，就可以点击`STG`、`PRE`、`PRD`去访问该项目。 但此时访问的项目只有一个基础的架子，还没有内容载体，所以，我们需要创建菜单，给菜单关联一个页面才算完成一个完整的项目。
+如果你要开发一个全新的项目，你可以考虑在平台创建一个项目，然后创建页面，最后关联菜单。
+
+如果你本身已经有一个传统项目，此时你只需要在平台创建页面即可，最后通过微服务集成到你的业务系统中。
 
 ![菜单关联页面](/home/page.png)