Skip to content

Commit 3dcd52f

Browse files
authored
Merge pull request #1489 from haoxiuwen/doc-v2
Optimize Applet Integration Docs
2 parents 5988dd0 + a9e0b76 commit 3dcd52f

File tree

5 files changed

+63
-80
lines changed

5 files changed

+63
-80
lines changed

docs/document/applet/alipay.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
<Toc />
44

5-
### 注册环信账号
5+
支付宝小程序 SDK 集成步骤如下:
66

7-
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。
7+
## 步骤一 注册环信账号
88

9-
### 搭建支付宝小程序开发环境
9+
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),获取唯一 App Key,SDK 初始化时需要配置 App Key。
10+
11+
## 步骤二 搭建支付宝小程序开发环境
1012

1113
首先需要下载并安装 [开发者工具](https://opendocs.alipay.com/mini/ide/download),然后按照支付宝小程序的 [接入流程](https://opendocs.alipay.com/mini/006kyi) 一步步创建一个小程序。
1214

13-
### 配置服务器域名
15+
## 步骤三 配置服务器域名
1416

1517
小程序在发布前,需要配置合法域名。
1618

@@ -38,36 +40,32 @@
3840

3941
![img](/images/applet/service_overview.png)
4042

41-
### 说明
42-
43+
:::tip
4344
支付宝小程序:支付宝小程序在一段时间内只能保留一个 WebSocket 连接,如果当前已存在 WebSocket 连接,那么会自动关闭该连接,并重新创建一个新的 WebSocket 连接。
45+
:::
4446

45-
### 集成 SDK
46-
47-
#### 下载 SDK
47+
## 步骤四 下载 SDK
4848

4949
可以通过以下两种方式获取 SDK:
5050

51-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
51+
- 通过官网 [下载 SDK](https://www.easemob.com/download/im#applets)
5252
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件。
5353

54-
#### 引入 SDK
54+
## 步骤五 引入 SDK
5555

5656
- 开始一个全新的项目
5757
1. 将下载的 SDK(src/sdk/)导入到自己的项目中。
5858
2. 引入 SDK:`import EasemobChat from "../sdk/Easemob-chat-4.x.x.js";`
5959
- 基于 Demo 二次开发
6060

61-
将下载的代码导入开发者工具即可运行起来。
62-
63-
#### 调用示例
61+
将下载的代码导入开发者工具即可运行起来。调用示例如下:
6462

6563
```javascript
6664
//使用示例
6765
import EasemobChat from "../sdk/Easemob-chat-4.x.x.js"; // 4.0 版本sdk
6866
```
6967

70-
#### 实例调用方式
68+
## 步骤六 实例化 SDK
7169

7270
实例化 SDK,并挂载在全局对象下。
7371

docs/document/applet/baidu.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# 百度小程序集成介绍
22

3-
<Toc />
3+
百度小程序 SDK 集成步骤如下:
44

5-
### 注册环信账号
5+
## 步骤一 注册环信账号
66

7-
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html)来获取唯一 App Key,SDK 初始化时需要配置 App Key。
7+
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html)获取唯一 App Key,SDK 初始化时需要配置 App Key。
88

9-
### 搭建百度小程序开发环境
9+
## 步骤二 搭建百度小程序开发环境
1010

1111
首先需要下载并安装 [开发者工具](https://smartprogram.baidu.com/docs/introduction/tool/),然后按照百度小程序的 [接入流程](https://smartprogram.baidu.com/docs/develop/tutorial/startdevelop/) 一步步创建一个小程序。
1212

13-
### 配置服务器域名
13+
## 步骤三 配置服务器域名
1414

1515
小程序在发布前,需要配置合法域名。
1616

@@ -38,20 +38,18 @@
3838

3939
![img](/images/applet/service_overview.png)
4040

41-
### 说明
42-
41+
:::tip
4342
百度小程序注册主体不能为个人,必须为企业、媒体、政府等。
43+
:::
4444

45-
### 集成 SDK
46-
47-
#### 下载 SDK
45+
## 步骤四 下载 SDK
4846

4947
可以通过以下两种方式获取 SDK:
5048

5149
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
5250
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件
5351

54-
#### 引入 SDK
52+
## 步骤五 引入 SDK
5553

5654
- 开始一个全新的项目
5755
1. 将下载的 SDK(src/sdk/)导入到自己的项目中。
@@ -60,14 +58,14 @@
6058

6159
将下载的代码导入开发者工具即可运行起来。
6260

63-
#### 调用示例
61+
调用示例如下所示:
6462

6563
```javascript
6664
//使用示例
6765
import EasemobChat from "../sdk/Easemob-chat-4.x.x.js"; // 4.0 版本sdk
6866
```
6967

70-
#### 实例调用方式
68+
## 步骤六 实例化 SDK
7169

7270
实例化 SDK,并挂载在全局对象下。
7371

@@ -80,5 +78,6 @@ WebIM.conn = new WebIM.connection({
8078
useOwnUploadFun: false, // 是否使用自己的上传方式(如将图片文件等上传到自己的服务器,构建消息时只传url)
8179
isHttpDNS: false, // 在小程序上需设置为false
8280
});
81+
```
8382

8483
小程序端的基本功能和 Web 端一致,请参考 [Web 端文档](/document/web/integration.html)

docs/document/applet/bytedance.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
<Toc />
44

5-
### 注册环信账号
5+
抖音小程序 SDK 集成步骤如下:
66

7-
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。
7+
## 步骤一 注册环信账号
88

9-
### 搭建抖音小程序开发环境
9+
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),获取唯一 App Key,SDK 初始化时需要配置 App Key。
10+
11+
## 步骤二 搭建抖音小程序开发环境
1012

1113
首先需要下载并安装 [开发者工具](https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/developer-instrument/developer-instrument-update-and-download/),然后按照抖音小程序的 [接入流程](https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/guide/start/kick-off) 一步步创建一个小程序。
1214

13-
### 配置服务器域名
15+
## 步骤三 配置服务器域名
1416

1517
小程序在发布前,需要配置合法域名。
1618

@@ -38,33 +40,28 @@
3840

3941
![img](/images/applet/service_overview.png)
4042

41-
### 集成 SDK
42-
43-
#### 下载 SDK
43+
## 步骤四 下载 SDK
4444

4545
可以通过以下两种方式获取 SDK:
4646

4747
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
4848
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件
4949

50-
51-
#### 引入 SDK
50+
## 步骤五 引入 SDK
5251

5352
- 开始一个全新的项目
5453
1. 将下载的 SDK(src/sdk/)导入到自己的项目中。
5554
2. 引入 SDK:`import EasemobChat from "../sdk/Easemob-chat-4.x.x.js";`
5655
- 基于 Demo 二次开发
5756

58-
将下载的代码导入开发者工具即可运行起来。
59-
60-
#### 调用示例
57+
将下载的代码导入开发者工具即可运行起来。调用示例如下:
6158

6259
```javascript
6360
//使用示例
6461
import EasemobChat from "../sdk/Easemob-chat-4.x.x.js"; // 4.0 版本sdk
6562
```
6663

67-
#### 实例调用方式
64+
## 步骤六 实例调用方式
6865

6966
实例化 SDK,并挂载在全局对象下。
7067

@@ -77,6 +74,6 @@ WebIM.conn = new WebIM.connection({
7774
useOwnUploadFun: false, // 是否使用自己的上传方式(如将图片文件等上传到自己的服务器,构建消息时只传url)
7875
isHttpDNS: false, // 在小程序上需设置为false
7976
});
80-
77+
```
8178

8279
小程序端的基本功能和 Web 端一致,请参考 [Web 端文档](/document/web/integration.html)

docs/document/applet/qq.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,21 @@
22

33
<Toc />
44

5-
## 前提条件
5+
QQ 小程序 SDK 集成步骤如下:
66

7-
### 注册环信账号
7+
## 步骤一 注册环信账号
88

9-
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),来获取唯一 appKey,SDK 初始化时需要配置 appKey。
9+
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html) 获取唯一 appKey,SDK 初始化时需要配置 appKey。
1010

11-
## 实现步骤
12-
13-
### 搭建 QQ 小程序开发环境
11+
## 步骤二 搭建 QQ 小程序开发环境
1412

1513
首先需要下载并安装 [开发者工具](https://q.qq.com/wiki/tools/devtool/),然后按照 QQ 小程序的 [接入流程](https://q.qq.com/wiki/#_2-注册开发者平台) 一步步创建一个小程序
1614

17-
### 配置服务器域名
15+
## 步骤三 配置服务器域名
1816

1917
小程序在发布前,需要配置合法域名。
2018

21-
登录 QQ 小程序 [开发者平台](https://q.qq.com/),进入 开发 > 开发设置 页面配置以下服务器地址。
19+
登录 QQ 小程序 [开发者平台](https://q.qq.com/),进入 **开发 > 开发设置** 页面配置以下服务器地址。
2220

2321
| 域名类型 | 具体域名 |
2422
| :------ | :----- |
@@ -42,36 +40,32 @@
4240

4341
![img](/images/applet/service_overview.png)
4442

45-
### 说明
46-
43+
:::tip
4744
QQ、微信小程序: 1.7.0 及以上版本,最多可以同时存在 5 个 WebSocket 连接,需开发者控制好连接数量,超出此限制 SDK 将不能连接上服务器。
45+
:::
4846

49-
### 集成 SDK
50-
51-
#### 下载 SDK
47+
## 步骤四 下载 SDK
5248

5349
可以通过以下两种方式获取 SDK:
5450

55-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
56-
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件
51+
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
52+
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件
5753

58-
#### 引入 SDK
54+
## 步骤五 引入 SDK
5955

6056
- 开始一个全新的项目
6157
1. 将下载的 SDK(src/sdk/)导入到自己的项目中。
6258
2. 引入 SDK:`import EasemobChat from "../sdk/Easemob-chat-4.x.x.js";`
6359
- 基于 Demo 二次开发
6460

65-
将下载的代码导入开发者工具即可运行起来。
66-
67-
#### 调用示例
61+
将下载的代码导入开发者工具即可运行起来。调用示例如下:
6862

6963
```javascript
7064
//使用示例
7165
import EasemobChat from "../sdk/Easemob-chat-4.x.x.js"; // 4.0 版本sdk
7266
```
7367

74-
#### 实例调用方式
68+
## 步骤六 实例化 SDK
7569

7670
实例化 SDK,并挂载在全局对象下。
7771

@@ -84,5 +78,6 @@ WebIM.conn = new WebIM.connection({
8478
useOwnUploadFun: false, // 是否使用自己的上传方式(如将图片文件等上传到自己的服务器,构建消息时只传url)
8579
isHttpDNS: false, // 在小程序上需设置为false
8680
});
81+
```
8782

8883
小程序端的基本功能和 Web 端一致,请参考 [Web 端文档](/document/web/integration.html)

docs/document/applet/wechat.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
1-
# 微信小程序集成介绍
1+
# 微信小程序集成
22

33
<Toc />
44

5-
### Demo 体验
5+
微信小程序 SDK 集成步骤如下:
66

7-
你可以[体验微信小程序 Demo](/product/demo.html#各端原生开发-demo),使用微信扫描二维码,并查看 Demo 源码。
7+
## 步骤一 注册环信账号
88

9-
### 注册环信账号
9+
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),获取唯一 App Key,SDK 初始化时需要配置 App Key。
1010

11-
开发者需要在环信控制台 [注册并创建应用](/product/console/app_create.html),来获取唯一 App Key,SDK 初始化时需要配置 App Key。
12-
13-
### 搭建微信小程序开发环境
11+
## 步骤二 搭建微信小程序开发环境
1412

1513
首先需要下载并安装 [开发者工具](https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html),然后按照微信小程序的 [接入流程](https://developers.weixin.qq.com/miniprogram/dev/framework/quickstart/getstart.html#%E7%94%B3%E8%AF%B7%E5%B8%90%E5%8F%B7)一步步创建一个小程序。
1614

17-
### 配置服务器域名
15+
## 步骤三 配置服务器域名
1816

1917
小程序在发布前,需要配置合法域名。
2018

@@ -44,32 +42,28 @@
4442

4543
![img](/images/applet/service_overview.png)
4644

47-
### 集成 SDK
48-
49-
#### 下载 SDK
45+
## 步骤四 下载 SDK
5046

5147
可以通过以下两种方式获取 SDK:
5248

53-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
54-
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件
49+
- 通过官网 [下载 SDK](https://www.easemob.com/download/im#applets)
50+
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件
5551

56-
#### 引入 SDK
52+
## 步骤五 引入 SDK
5753

5854
- 开始一个全新的项目
5955
1. 将下载的 SDK(src/sdk/)导入到自己的项目中。
6056
2. 引入 SDK:`import EasemobChat from "../sdk/Easemob-chat.js";`
6157
- 基于 Demo 二次开发
6258

63-
将下载的代码导入开发者工具即可运行起来。
64-
65-
#### 调用示例
59+
将下载的代码导入开发者工具即可运行起来。调用示例如下:
6660

6761
```javascript
6862
//使用示例
6963
import EasemobChat from "../sdk/Easemob-chat-4.x.x.js"; // 4.0 版本sdk
7064
```
7165

72-
#### 实例调用方式
66+
## 步骤六 实例化 SDK
7367

7468
实例化 SDK,并挂载在全局对象下。
7569

0 commit comments

Comments
 (0)