@seafile/sdoc-editor

Seafile-editor

项目是基于 react-slate 组件库的二次封装, 用于满足公司富文本编辑器的使用需求

目录结构

seafile-editor/
  dist                      // 打包后的文件
  node_modules/             // 依赖第三方组件库
  public/                   // 公共资源文件库
    index.html                 
    favicon.ico
  site(demo 模块, 基于组件库创建的测试模块)
    _i18n                   // 国际化模块
    api                     // api 模块
    assets                  // css 文件, 图片文件
    commons                 // 公共组件
    components              // 应用组件
    containers              // 容器组件
    pages                   // 页面组件
    app.js                  // 应用对象
    index.html              // 主页
    index.js                // 应用入口
    setting.js              // 应用配置文件
    setting.local.dist.js   // 应用配置模版
    setting.local.dist      // 用户基于 setting.local.dist.js copy 一份的配置文件
  src/(组件库)
    assets                  // css 文件, 资源文件
    components              // 封装的视图组件
    editor                  // 封装的编辑器组件
    lib                     // 底层接口
    utils                   // 工具接口
    viewer                  // 封装的视图组件
    index.js                // 组件库导出内容入口文件
  tests                     // 测试
  webpack                   // site 打包文件   
  config.js                 // site 打包配置文件
  dev-server.js             // site 后端服务器
  package.json
  readme.md                 // 组件库说明文档

本地测试步骤

1. 新增本地配置文件 setting.local.js(基于 /site/setting.local.dist.js copy 一份)
2. 在 seahub 项目创建一个测试文件, 根据需要的配置信息完善配置内容
3. 执行 npm run start, 启动测试服务, 可以打开相应的网址, 对封装的组件进行测试

新版本发布

1. 更新 package.json 中的 version 属性
2. 执行 npm publish 完成新版本发布