Skip to content

Commit 68178c1

Browse files
committed
feat: modify document demo
1 parent e5795e5 commit 68178c1

11 files changed

Lines changed: 24 additions & 49 deletions

File tree

packages/docs/fluent-editor/docs/demo/emoji.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ npm i @floating-ui/dom @emoji-mart/data emoji-mart
1414

1515
> `emojiData``EmojiPicker``emojiPickerPosition` 支持通过 window 传入
1616
17-
:::demo src=demos/emoji.vue
18-
:::
17+
<demo vue="../../demos/emoji.vue" />
1918

2019
## Options
2120

packages/docs/fluent-editor/docs/demo/flow-chart.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,25 @@ npm install @logicflow/core @logicflow/extension
2323

2424
通过配置工具栏按钮 `flow-chart`,并启用 `flow-chart`模块: `'flow-chart': true` 可以开启流程图功能。
2525

26-
:::demo src=demos/flow-chart.vue
27-
:::
26+
<demo vue="../../demos/flow-chart.vue" />
2827

2928
## 网格样式
3029

3130
流程图模块支持配置网格样式,可以配置网格大小、颜色、类型等设置。
3231

33-
:::demo src=demos/flow-chart-grid.vue
34-
:::
32+
<demo vue="../../demos/flow-chart-grid.vue" />
3533

3634
## 背景样式
3735

3836
流程图模块支持配置背景样式,可以配置背景颜色、图片等设置。
3937

40-
:::demo src=demos/flow-chart-background.vue
41-
:::
38+
<demo vue="../../demos/flow-chart-background.vue" />
4239

4340
## 调整大小
4441

4542
流程图模块支持调整流程图的大小,拖动调整手柄可以改变流程图的尺寸。
4643

47-
:::demo src=demos/flow-chart-resize.vue
48-
:::
44+
<demo vue="../../demos/flow-chart-resize.vue" />
4945

5046
## 配置
5147

packages/docs/fluent-editor/docs/demo/markdown.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@
44

55
比如:输入 `#`,再按空格键,即可插入一级标题格式;输入 `-`,再按空格键,即可插入无序列表格式;输入 `>`,再按空格键,即可插入引用格式。
66

7-
:::demo src=demos/markdown.vue
8-
:::
7+
<demo vue="../../demos/markdown.vue" />

packages/docs/fluent-editor/docs/demo/mention.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,20 @@
66

77
通过配置 `mention` 模块,可以开启@提醒功能。
88

9-
:::demo src=demos/mention.vue
10-
:::
11-
9+
<demo vue="../../demos/mention.vue" />
1210
## 自定义列表样式
1311

1412
通过配置 `renderMentionItem` 方法,可以自定义选项列表的样式。
1513

16-
:::demo src=demos/mention-custom-list.vue
17-
:::
14+
<demo vue="../../demos/mention-custom-list.vue" />
1815

1916
## 跳转链接
2017

2118
在数据中配置`link``target`属性,可设置提醒跳转的链接,对应`a`标签的`href``target`属性。
2219

2320
当编辑器处于可编辑状态时,链接跳转不可以,注意切换为只读状态。
2421

25-
:::demo src=demos/mention-link.vue
26-
:::
22+
<demo vue="../../demos/mention-link.vue" />
2723

2824
## API
2925

packages/docs/fluent-editor/docs/demo/mind-map.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,36 +23,31 @@ npm install simple-mind-map simple-mind-map-plugin-themes
2323

2424
通过配置工具栏按钮 `mind-map`,并启用 `mind-map`模块: `'mind-map': true` 可以开启思维导图功能。
2525

26-
:::demo src=demos/mind-map.vue
27-
:::
26+
<demo vue="../../demos/mind-map.vue" />
2827

2928
## 背景样式
3029

3130
思维导图模块支持配置背景样式,可以配置背景颜色、图片等设置。
3231

33-
:::demo src=demos/mind-map-background.vue
34-
:::
32+
<demo vue="../../demos/mind-map-background.vue" />
3533

3634
## 调整大小
3735

3836
思维导图模块支持调整思维导图的大小,拖动调整手柄可以改变思维导图的尺寸。
3937

40-
:::demo src=demos/mind-map-resize.vue
41-
:::
38+
<demo vue="../../demos/mind-map-resize.vue" />
4239

4340
## 连线样式
4441

4542
思维导图模块支持配置连线样式,可以配置连线颜色、样式等设置。其中曲线只在logicalStructure逻辑结构图和mindMap思维导图两种结构时生效。
4643

47-
:::demo src=demos/mind-map-line.vue
48-
:::
44+
<demo vue="../../demos/mind-map-line.vue" />
4945

5046
## 主题样式
5147

5248
思维导图模块支持配置主题样式,传入主题名称即可。需要注意的是设置了主题后改变的是节点,连线,背景等相关样式,所以设置了主题和背景样式和连线样式后,背景样式和连线样式会覆盖与其相关的主题样式。
5349

54-
:::demo src=demos/mind-map-theme.vue
55-
:::
50+
<demo vue="../../demos/mind-map-theme.vue" />
5651

5752
## 配置
5853

packages/docs/fluent-editor/docs/demo/readonly.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22

33
通过配置 `modules.toolbar` 为 false 可以隐藏工具栏,配置 `readOnly` 为 true 可以设置只读模式。
44

5-
:::demo src=demos/readonly.vue
6-
:::
5+
<demo vue="../../demos/readonly.vue" />

packages/docs/fluent-editor/docs/demo/screenshot.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,15 @@ import Html2Canvas from 'html2canvas'
1111
window.Html2Canvas = Html2Canvas
1212
```
1313

14-
:::demo src=demos/screenshot.vue
15-
:::
14+
<demo vue="../../demos/screenshot.vue" />
1615

1716
## 上传截图
1817

1918
除了将 `Html2Canvas` 变量暴露在 `window` 上,还可以将 Html2Canvas 变量传入 screenshot 配置项中。
2019

2120
默认截图的格式是 Base64,你可以在 `screenshot.beforeCreateImage` 中处理截屏图片,将图片上传到服务器,再将服务器返回的图片 URL 显示到编辑器中。
2221

23-
:::demo src=demos/screenshot-upload-to-server.vue
24-
:::
22+
<demo vue="../../demos/screenshot-upload-to-server.vue" />
2523

2624
## API
2725

packages/docs/fluent-editor/docs/demo/set-content.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@
44

55
通过设置 `editor.root.innerHTML`,可以初始化 HTML 内容。
66

7-
:::demo src=demos/set-content-html.vue
8-
:::
7+
<demo vue="../../demos/set-content-html.vue" />
98

109
## 初始化 Delta 内容
1110

1211
配置调用 `editor.setContents()` 方法,可以初始化 Delta 内容。
1312

14-
:::demo src=demos/set-content-delta.vue
15-
:::
13+
<demo vue="../../demos/set-content-delta.vue" />

packages/docs/fluent-editor/docs/demo/shortcut-key.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22

33
快捷菜单功能默认关闭,可通过配置 `shortcut-key` 模块为 true 进行开启,开启后,placeholder 会显示“输入 / 唤起菜单”,当我们在空行输入 `/` 时就会唤起快捷菜单,可以通过方向键进行菜单选择,按 Enter 确定,实现纯键盘操作,提升操作效率。
44

5-
:::demo src=demos/shortcut-key.vue
6-
:::
5+
<demo vue="../../demos/shortcut-key.vue" />

packages/docs/fluent-editor/docs/demo/table-up.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,12 @@ npm install quill-table-up
1010

1111
## 单元格操作菜单
1212

13-
:::demo src=demos/table-up-menu.vue
14-
:::
13+
<demo vue="../../demos/table-up-menu.vue" />
1514

1615
## 单元格大小调整
1716

18-
:::demo src=demos/table-up-resize.vue
19-
:::
17+
<demo vue="../../demos/table-up-resize.vue" />
2018

2119
## 快捷菜单配置
2220

23-
:::demo src=demos/table-up-shortcut.vue
24-
:::
21+
<demo vue="../../demos/table-up-shortcut.vue" />

0 commit comments

Comments
 (0)