fix: fix potential issue

opentiny · Dec 3, 2024 · ef6228d · ef6228d
1 parent fc45cc1
commit ef6228d
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 42 deletions.
diff --git a/docs/基础功能/初识设计器.md b/docs/基础功能/初识设计器.md
@@ -2,13 +2,13 @@
 
 > 本节主要简单介绍设计器界面模块
 
-### 设计器界面概览
+## 设计器界面概览
 
 ![设计器界面示例图](./imgs/platformExpend.png)
 
 如上图，设计器可以分为顶部工具栏、左侧插件栏、中间画布区、右侧设置面板等几个主要界面模块
 
-### 顶部工具栏
+## 顶部工具栏
 
 ![顶部工具栏示例图](./imgs/toolbaroverview.png)
 
@@ -27,21 +27,21 @@
 - 设置功能，点击可展开左侧页面或区块的设置插件，管理当前页面或者区块
 - 画布中英文切换，点击可切换画布中英文，测试国际化能力
 
-### 左侧插件栏
+## 左侧插件栏
 
 ![插件栏示意图](./imgs/pluginoverview.png)
 
 如上图所示，插件面板主要有物料插件、大纲树插件、页面管理工具插件、区块管理插件、数据源管理插件、资源管理插件、国际化插件、JS 方法插件、状态管理插件
 
 插件点击之后会向右展开对应插件的设置面板
 
-### 中心画布
+## 中心画布
 
 ![中心画布](./imgs/canvasoverview.png)
 
 如上图所示，中心画布位于设计器中央，是可视化设计的核心模块，可以在插件栏中的物料面板往中心画布拖入组件，也可以点击画布选中组件，修改组件的属性、样式、绑定事件等等
 
-### 右侧设置面板
+## 右侧设置面板
 
 右侧设置面板分为属性设置、样式设置、高级设置等面板
 
@@ -55,7 +55,7 @@
 
 ![高级设置图示](./imgs/eventOverview.png)
 
-### 底部节点树
+## 底部节点树
 
 ![底部节点树图示](./imgs/treeselectOverview.png)
 

diff --git a/docs/基础功能/国际化.md b/docs/基础功能/国际化.md
@@ -69,7 +69,7 @@
 2. 在物料资产包中选择组件，例如button组件，并拖拽至中心画布中。
 3. 选中组件，在组件属性设置面板选择“属性”。
 4. 选中文案参数旁的![](./imgs/icon-code.png)，进行变量绑定。
-5. 输入变量t\('lowcode.67564435'\)，其中lowcode.67564435为词条的key值，可参考[复制词条键值](#section4672122212320)获取。
+5. 输入变量t\('lowcode.67564435'\)，其中lowcode.67564435为词条的key值，可参考[复制词条键值](#复制词条键值)获取。
 
    **图 6**  绑定变量 
    ![](./imgs/bindVariable-25.png "绑定变量-25")

diff --git a/docs/基础功能/样式设置.md b/docs/基础功能/样式设置.md
@@ -19,7 +19,7 @@
  </div>
 </template>
 
-<style scope>
+<style scoped>
 .card {
   display: block;
   color: red;

diff --git a/docs/基础功能/设计器界面模块简介.md b/docs/基础功能/设计器界面模块简介.md
@@ -2,13 +2,13 @@
 
 > 本节主要简单介绍设计器界面模块
 
-### 设计器界面概览
+## 设计器界面概览
 
 ![设计器界面示例图](./imgs/platformExpend.png)
 
 如上图，设计器可以分为顶部工具栏、左侧插件栏、中间画布区、右侧设置面板等几个主要界面模块
 
-### 顶部工具栏
+## 顶部工具栏
 
 ![顶部工具栏示例图](./imgs/toolbaroverview.png)
 
@@ -27,21 +27,21 @@
 - 设置功能，点击可展开左侧页面或区块的设置插件，管理当前页面或者区块
 - 画布中英文切换，点击可切换画布中英文，测试国际化能力
 
-### 左侧插件栏
+## 左侧插件栏
 
 ![插件栏示意图](./imgs/pluginoverview.png)
 
 如上图所示，插件面板主要有物料插件、大纲树插件、页面管理工具插件、区块管理插件、数据源管理插件、资源管理插件、国际化插件、JS 方法插件、状态管理插件
 
 插件点击之后会向右展开对应插件的设置面板
 
-### 中心画布
+## 中心画布
 
 ![中心画布](./imgs/canvasoverview.png)
 
 如上图所示，中心画布位于设计器中央，是可视化设计的核心模块，可以在插件栏中的物料面板往中心画布拖入组件，也可以点击画布选中组件，修改组件的属性、样式、绑定事件等等
 
-### 右侧设置面板
+## 右侧设置面板
 
 右侧设置面板分为属性设置、样式设置、高级设置等面板
 
@@ -55,7 +55,7 @@
 
 ![高级设置图示](./imgs/eventOverview.png)
 
-### 底部节点树
+## 底部节点树
 
 ![底部节点树图示](./imgs/treeselectOverview.png)
 

diff --git a/docs/开始/简介.md b/docs/开始/简介.md
@@ -1,14 +1,14 @@
 # 简介
 
-### TinyEngine 低代码引擎
+## TinyEngine 低代码引擎
 
 TinyEngine 是开源的低代码引擎，使能开发者定制低代码平台。它是低代码平台的底座，提供可视化搭建页面等基础能力，既可以通过线上搭配组合，也可以通过下载源码进行二次开发，实时定制出自己的低代码平台。
 
-### 设计理念
+## 设计理念
 
 TinyEngine 的设计理念是通过简化复杂的开发过程，使更多的企业或组织用户能够轻松创建高效、功能丰富的低代码平台。它采用模块化设计，开发者可以通过模块的配置、替换、覆盖来构建符合企业组织理念的的低代码平台，打造出专业级的企业应用程序生成器。
 
-### 功能特性
+## 功能特性
 
 - 跨端跨框架前端组件
 - 支持在线实时构建、支持二次开发或被集成
@@ -17,13 +17,13 @@ TinyEngine 的设计理念是通过简化复杂的开发过程，使更多的企
 - 支持高代码与低代码，混合开发部署应用
 - 平台接入 AI 大模型能力，辅助开发者构建应用
 
-### 应用场景
+## 应用场景
 
 TinyEngine 适用于各种类型的企业和组织，包括中小型企业、非营利组织以及大型企业。它可以用于开发多种类型的应用程序，如内部工具、客户关系管理系统（CRM）、企业资源规划系统（ERP）、电子商务平台等。
 
 通过物料的导入、画布和出码的定制，TinyEngine可以定制化成企业和组织内部专用的页面和应用生成平台。它具备强大的扩展性，开放的协议接口，使得定制化更加灵活，能覆盖大部分低代码编排场景。
 
-### 基于TinyEngine定制低代码平台案例
+## 基于TinyEngine定制低代码平台案例
 
 1） 图元编排
 完备的画布拖拽绘图核心能力，灵活的属性配置面板，支持领域定制物料，轻松定制强大的图元编排设计器。
@@ -34,11 +34,11 @@ TinyEngine 适用于各种类型的企业和组织，包括中小型企业、非
 3） 页面编排
 拥有丰富的图表组件，提供多种页面布局模式，轻松拖拽区块即可生成各种页面结构，同时支持移动端的屏幕编排。
 
-### 社区贡献
+## 社区贡献
 
 作为一个开源项目，TinyEngine 鼓励开发者社区的贡献。用户不仅可以使用现有的功能和组件，还可以开发和共享自己的组件，丰富平台的生态系统。这种社区驱动的发展模式，不仅加速了功能的迭代，也提高了平台的可用性和可靠性。
 
-### 未来发展
+## 未来发展
 
 随着低代码平台的普及，TinyEngine 将不断优化和扩展其功能。未来，TinyEngine 可能会集成更多的人工智能和机器学习功能，使得应用程序更加智能化和自动化。同时，团队将继续提升用户体验，确保平台的易用性和灵活性。
 

diff --git a/docs/扩展能力使用教程/出码功能/如何自定义出码.md b/docs/扩展能力使用教程/出码功能/如何自定义出码.md
@@ -92,7 +92,7 @@ const customDataSourcePlugin = () => {
   return {
     name: '',
     description: '',
-    run: () {
+    run: () => {
       // ... 自定义出码逻辑
     }
   }

diff --git a/docs/扩展能力使用教程/开发设置器组件.md b/docs/扩展能力使用教程/开发设置器组件.md
@@ -11,7 +11,7 @@
 设置器组件可以有多种形式，它们都需要遵循以下规范：
 
 - 是一个 vue 的单文件组件
-- 组件的 props 必须要有 `modalValue` 属性
+- 组件的 props 必须要有 `modelValue` 属性
 - 组件的 emits 必须支持 `update:modelValue` 事件
 
 例如我们使用 TinyVue 的 Input 组件开发一个输入框设置器，输入的字符只支持字母或者数字，代码如下

diff --git a/docs/新手指引/快速上手.md b/docs/新手指引/快速上手.md
@@ -5,39 +5,42 @@
 
 通过这个案例，开发者可以快速学习如何利用TinyEngine的低代码特性，实现界面交互逻辑。
 
-### 效果图
+## 效果图
 
-![](./imgs/showImg.png)
+![案例的效果图](./imgs/showImg.png)
 
-### 第一步，新建页面
+## 第一步，新建页面
 
-![](./imgs/page1.png)
+![步骤1 - 新建页面的操作界面](./imgs/page1.png)
 
-### 第二步，拖入元素
+## 第二步，拖入元素
 
-![](./imgs/addComponent.png)
+![步骤2 - 拖入元素的操作演示](./imgs/addComponent.png)
 
-### 第三步，设置状态变量
+## 第三步，设置状态变量
 
-![](./imgs/addState.png)
+![步骤3 - 设置状态变量的配置界面](./imgs/addState.png)
+
+## 第四步，设置文本和图片地址：
 
-### 第四步，设置文本和图片地址：
 修改text属性，修改文本为：“图片显示开关”
 设置src属性，修改图片地址为：`https://res.hc-cdn.com/lowcode-portal/1.1.65/img/home/top-banner.jpg`
 
-![img.png](./imgs/imgswitch.png)![img.png](./imgs/setImgSrc.png)
+![步骤4.1 - 设置文本属性](./imgs/imgswitch.png)
+![步骤4.2 - 设置图片地址](./imgs/setImgSrc.png)
 
-### 第五步，设置图片样式和绑定显示变量
+## 第五步，设置图片样式和绑定显示变量
 
-![img.png](./imgs/setImgSty.png)![img.png](./imgs/setImgSta.png)
+![步骤5.1 - 设置图片样式](./imgs/setImgSty.png)
+![步骤5.2 - 绑定显示变量](./imgs/setImgSta.png)
 
-### 第六步，给开关绑定事件
+## 第六步，给开关绑定事件
 
-![img.png](./imgs/bangEnv.png)
+![步骤6 - 绑定事件配置界面](./imgs/bangEnv.png)
 
-### 第七步，绑定点击事件并预览
+## 第七步，绑定点击事件并预览
 
-![img.png](./imgs/preImgChange.png)
+![步骤7 - 绑定点击事件并预览](./imgs/preImgChange.png)
 
-### 恭喜你，完成了这个小案例。
+## 恭喜你，完成了这个小案例。
 
diff --git a/docs/新手指引/简介.md b/docs/新手指引/简介.md
@@ -12,11 +12,11 @@
 低代码引擎它内置了一个功能强大的低代码设计器，用户可以基于低代码引擎定制（开发）出各种低代码平台，如：流程编排平台、页面编排平台、图元编排平台、移动端页面开发平台
 、大屏开发平台等等......
 
-![](./imgs/tinyengine.png "创建应用")
+![基于低代码引擎的应用开发流程](./imgs/tinyengine.png)
 
 ## TinyEngine 低代码引擎介绍
 
-![](./imgs/firstPage.png "创建应用")
+![TinyEngine平台界面预览](./imgs/firstPage.png)
 
 1. 可以定制开发低码平台： TinyEngine 提供了一套完善的插件体系，涵盖了插件开发所需的基础 UI 库、工具库、插件面板的显示控制、生命周期管理、公共 API 注册与共享等。