https://github.com/flrande/circu
https://github.com/flrande/circu
collaborative-editing editor
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/flrande/circu
- Owner: Flrande
- Created: 2022-03-09T07:40:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-13T03:01:31.000Z (over 2 years ago)
- Last Synced: 2025-03-24T22:31:54.779Z (7 months ago)
- Topics: collaborative-editing, editor
- Language: TypeScript
- Homepage:
- Size: 6.62 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Circu
本项目是一个支持多人协同的在线文档应用，仓库主体是基于 pnpm Workspace 配置的 monorepo，包含以下 4 个包：
- circu-editor - 富文本编辑器模块
- circu-server - 应用后端
- circu-wiki - 应用前端
- slate-react - circu-editor 的渲染层部分, 主要代码来自于 [Slate.js 官方](https://github.com/ianstormtaylor/slate)
## Usage
本项目仍处在开发阶段，编辑器之后会用 [blocksuite](https://github.com/toeverything/blocksuite) 重写
## Roadmap
### circu-editor
- [x] 支持内容块缩进和单行缩进，内容块缩进可以配合相关钮实现批量移动、展开和收起文档内容
- [x] 支持悬浮工具栏，可以通过悬浮工具栏更改行内或块级式
- [x] 支持 markdown 语法，详细语法可以通过将鼠标移动到浮工具栏的对应按钮上得知
- [ ] 任务列表
- [ ] 拖动按钮处的悬浮工具栏
- [ ] 支持对齐方式的调整
- [ ] 支持文档目录功能，通过多级标题生成文档目录，点击对目录文档可以跳转到对应位置
- [ ] 图片及动态图支持
- [ ] 单元测试
### circu-server
- [x] 支持基本的文档和文件夹管理功能
- [x] 支持基本的权限、分享和协作功能
- [ ] 支持文档多人协同
- [ ] 服务端实例支持横向扩展
- [ ] 支持文档历史记录回溯
- [ ] 支持为文档添加评论
- [ ] 支持云空间全文搜索
### slate-react
- [ ] 虚拟渲染