docs: update appliance-plugin.md

netless-io · Jan 17, 2025 · 2f21daf · 2f21daf
1 parent 5ae6c7d
commit 2f21daf
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/en/appliance-plugin.md b/docs/en/appliance-plugin.md
@@ -195,6 +195,7 @@ The following interfaces are involved:
     import { EStrokeType, ApplianceNames } from '@netless/appliance-plugin';
     room.setMemberState({currentApplianceName: ApplianceNames.laserPen, strokeType: EStrokeType.Normal});
     ```
+    ![Image](https://github.com/user-attachments/assets/3cd10c3a-b17b-4c01-b9d4-868c69116d96)
 2. Extended Teaching AIDS (Version >=1.1.1)
     ```js
     export enum EStrokeType { 
@@ -248,7 +249,7 @@ The following interfaces are involved:
     appliance.setMemberState({ ... } as ExtendMemberState);
     ```
 3. Split screen display Elements (little whiteboard featrue), need to combine '@netless/app-little-white-board' (Version >=1.1.3)
-
+    ![Image](https://github.com/user-attachments/assets/20810ea6-7d85-4e72-b75f-185599fffaf8)
 4. Minimap function (Version >=1.1.6)
     ```js
     /** Create a minimap
@@ -259,6 +260,7 @@ The following interfaces are involved:
     /** Destroy minimap */
     destroyMiniMap(viewId: string): Promise<void>;
     ```
+    ![Image](https://github.com/user-attachments/assets/8888dc2f-ba66-4807-aa12-16530b3b8a3c)
 5. Filter Elements (Version >=1.1.6)
     ```js
     /** Filter Elements
@@ -276,6 +278,7 @@ The following interfaces are involved:
      */
     cancelFilterRender(viewId: string, isSync?:boolean): void;
     ```
+    ![Image](https://github.com/user-attachments/assets/7952ee1d-4f9c-4e86-802a-bac8e4ae6a51)
 6. Handwriting graphics automatic association function: 'autoDraw' (version >=1.1.7)
     ```js
     export type AutoDrawOptions = {
@@ -295,6 +298,7 @@ The following interfaces are involved:
     });
     plugin.usePlugin(autoDrawPlugin);
     ```
+    ![Image](https://github.com/user-attachments/assets/c388691c-ae72-44ec-bbb7-e92c3a73c9c7)
 ### Configure parameters 
 ``getInstance(wm: WindowManager, adaptor: ApplianceAdaptor)`` 
 - wm: WindowManager\room\player. In multi-window mode, you pass WindowManager, and in single-window mode, you pass room or player(whiteboard playback mode). 

diff --git a/docs/zh/appliance-plugin.md b/docs/zh/appliance-plugin.md
@@ -198,6 +198,7 @@ module: {
     import { EStrokeType, ApplianceNames } from '@netless/appliance-plugin';
     room.setMemberState({currentApplianceName: ApplianceNames.laserPen, strokeType: EStrokeType.Normal});
     ```
+    ![Image](https://github.com/user-attachments/assets/3cd10c3a-b17b-4c01-b9d4-868c69116d96)
 2. 扩展教具 (Version >=1.1.1)
     ```js
     export enum EStrokeType {
@@ -251,6 +252,7 @@ module: {
     appliance.setMemberState({ ... } as ExtendMemberState);
     ```
 3. 分屏显示笔记(小白板功能),需要结合 `@netless/app-little-white-board` (Version >=1.1.3)
+    ![Image](https://github.com/user-attachments/assets/20810ea6-7d85-4e72-b75f-185599fffaf8)
 4. 小地图功能 (Version >=1.1.6)
     ```js
     /** 创建小地图
@@ -261,6 +263,7 @@ module: {
     /** 销毁小地图 */
     destroyMiniMap(viewId: string): Promise<boolean>;
     ```
+    ![Image](https://github.com/user-attachments/assets/8888dc2f-ba66-4807-aa12-16530b3b8a3c)
 5. 过滤笔记 (Version >=1.1.6)
     ```js
     /** 过滤笔记
@@ -278,6 +281,7 @@ module: {
      */
     cancelFilterRender(viewId: string, isSync?:boolean): void;
     ```
+    ![Image](https://github.com/user-attachments/assets/7952ee1d-4f9c-4e86-802a-bac8e4ae6a51)
 6. 手写图形自动联想功能:`autoDraw` (version >=1.1.7)
     ```js
     export type AutoDrawOptions = {
@@ -297,6 +301,7 @@ module: {
     });
     plugin.usePlugin(autoDrawPlugin);
     ```
+    ![Image](https://github.com/user-attachments/assets/c388691c-ae72-44ec-bbb7-e92c3a73c9c7)
 
 ### 配置参数
 ``getInstance(wm: WindowManager, adaptor: ApplianceAdaptor)``