常见问题

这个组件适合直接做 npm 包文档吗

适合。这套页面本身就按产品文档站的方式组织，后续只需要继续补导航、侧边栏、版本记录和演示入口即可。

因为它和编辑器内部结构一致，回显更稳定，也更适合再次进入编辑态。

因为每个业务系统的上传接口、鉴权方式、存储平台、返回结构都不同，放到组件内部会很快失去通用性。

editable=false 更偏向关闭编辑能力，但仍保留原有编辑器壳层。mode="preview" 则是进入只读预览外壳，工具栏会隐藏，并支持更适合阅读场景的大纲布局和窄屏缩放。

不传时，内置导出项、插入菜单项和工具栏动作默认全部可用。只有当你显式传了数组，组件才会进入白名单裁剪模式。

因为协同模式下的唯一真实数据源是 Yjs 文档。如果要给房间预置内容，应在编辑器挂载前先写入 Y.Doc，或者由服务端进行初始化。

适合文档里插入业务附件、下载文件入口、材料清单等场景。业务侧可以监听 local-file-upload 和 local-file-download 事件，再决定如何上传、鉴权和下载。

如果你准备对外提供更完整的文档站，建议至少包含这些页面：

后续每增加一项公开能力，建议同步补三类内容：