警告
该存储库将经历重大变化,因此我们将中止接受PR。
阅读更多:#9045
真正认真对待编辑的人应该自己制作自己的框架。
BlockSuite是用于构建编辑和协作应用程序的工具包。它独立实施了一系列内容编辑基础架构,UI组件和编辑器。
您可以将BlockSuite作为UI组件库,用于构建各种编辑器,基于最小化的香草框架作为其运行时。使用Blocksuite,您可以:
PageEditor :全面的基于块的文档编辑器,提供广泛的自定义和灵活性。EdgelessEditor :具有选择加入画布渲染支持的图形编辑器,但也与PageEditor共享相同的丰富文本功能。? Blocksuite目前处于早期阶段,其组件和扩展功能仍在改进。希望您可以继续关注,尝试或分享您的反馈!
Blocksuite起源于仿射知识库,其设计目标包括:
在Aggine的发展过程中,很明显,Blocksuite不仅仅是成为内部编辑者,还发展成为一种多功能框架。这就是为什么我们选择独立开源和维护街区的原因。
使用BlockSuite编辑器,您可以选择性地重复使用Aggine中的所有编辑功能:

在引擎盖下,香草隔间框架支持:
要试用BlockSuite,请参阅快速启动示例,然后以@blocksuite/presets中的预设编辑器开始。
街区和仿射之间的关系与摩纳哥编辑器和VScode之间的关系相似,但是有一个主要区别:基于仿射代码库会自动生成BlockSuite,而是通过不同的技术堆栈独立维护,而Affine用途则使用了React React,而Blocksuite使用Web组件。
这种差异导致禁区基于以组分为中心的哲学设定明确的界限,以确保:
为此,BlockSuite项目围绕围绕分为两组的密钥软件包结构:无头框架和预构建的编辑组件。
| 框架 | |
|---|---|
@blocksuite/store | 用于建模协作文档状态的数据层。它是在CRDT库YJS上原产地建造的,它具有内置的实时协作和时间旅行功能,为所有Blocksuite文档提供动力。 |
@blocksuite/inline | 最小丰富的文本组件,用于内联编辑。 BlockSuite允许将不同的块节点中的丰富文本内容插入不同的内联编辑器中,从而使复杂的内容可以方便地组合。这大大降低了实施传统的丰富文本编辑功能所需的复杂性。 |
@blocksuite/block-std | 用于建模可编辑块的框架 - 敏捷库。它的功能涵盖了块字段,事件,选择,剪贴板支持等的结构。 |
| 成分 | |
|---|---|
@blocksuite/blocks | 用于编写预设编辑器的默认块实现,包括属于每个块的小部件。 |
@blocksuite/presets | 插件的可编辑组件,包括编辑器( PageEditor / EdgelessEditor )和名为Fragments ( CopilotPanel , DocTitle ...)的辅助UI组件。 |
有关如何从源头构建和测试街区的说明,请参见building.md。
BlockSuite接受GitHub上的拉请求。在开始贡献之前,请确保您已阅读并接受了我们的贡献许可协议。要指示您的协议,只需编辑此文件并提交拉动请求即可。
MPL 2.0