Home

BlockSuite is a framework providing building blocks for collaborative applications. With BlockSuite, you can build complex applications with fine-grained collaborative features without going down the rabbit hole of rich text editors and conflict resolution algorithms.

⚠️ This project is under heavy development and is in a stage of rapid evolution. Stay tuned!

Resources

• 🚧 Introduction
• 🚧 Tutorial
• 🚧 Examples
  • Latest Playground
  • AFFiNE Alpha Editor
• 🚧 API Reference
• 🚧 Troubleshooting
• 🚧 Releases

Help & Community

• GitHub Discussions
• Slack Channel
• AFFiNE Community
• Twitter

Current Status

The BlockSuite team now focuses on developing first-party blocks built for AFFiNE. Its developer documentation is not yet complete. But the project structure in this repository should already demonstrate some critical points about how it's supposed to be reused as a progressive framework:

• The packages/store package is a data store built for general-purpose state management.
• The packages/blocks package holds the default BlockSuite editable blocks.
• The packages/editor package ships a complete BlockSuite-based editor.