UNPKG

767 BMarkdownView Raw
1# 插件
2YDoc 强大的插件功能，满足你个性化的需求。
3
4## 浏览插件
5请访问 [ydoc 官网 - 插件](https://ydoc.ymfe.org/plugin/index.html) 浏览插件。
6
7## 安装插件
8
9假设要安装的插件名是 demo，执行如下命令：
10
11```bash
12npm install --save-dev ydoc-plugin-demo
13```
14
15安装完成后，请在 ydoc.json 配置项，添加：
16```json
17{
18 "plugins": ["demo"]
19}
20
21```
22
23## 插件配置
24部分插件需要做自定义配置, 假设 demo 插件需要添加 {id: 1} 的配置，只需要在 ydoc.json ，添加如下配置项：
25
26```json
27{
28 "pluginsConfig": {
29 "demo": {
30 "id": 1
31 }
32 }
33}
34
35```
36
37## 创建插件
38YDoc 插件是发布到 npm 的 node 包，本篇教程假定你已经拥有了 npm 和 node 相关的经验。