Repository files navigation

简体中文

For more detailed information, make sure to check out ourdocumentation. If you encounter any problems or have suggestions for our system, please open an issue.

isle-editor is an open-source web editor that supports rich text, block-based, andmarkdown editing. It's efficient and ready to use out of the box, built on top ofprosemirror andtiptap.

Withisle-editor we want to make it easy for developers to add text editing to their apps.isle-editor isnew compared to open-source editors on the market, and it supports the popularNotion Style style in addition to the normal rich text style.

You can outputHTML as a normal rich text editor orJSON as a block editor.

Considering the extensibility, you can use our built-in combo extensions to build the editor quickly, or you can selectively use our core extensions to customize your editor step by step, and you can also customize the extensions to enrich the functionality of the editor.

prosemirror is a powerful and flexible open-source rich text editing framework that provides a set of core tools andAPIs for building highly customizable rich text editors.tiptap is a modern rich text editor framework built on top ofprosemirror, providing higher-level abstractions and default implementations that make it more user-friendly.

Bothprosemirror andtiptap are headless, meaning they don't depend on any specific framework. Whiletiptap greatly simplifies editor development, it remains complex because it doesn't provide aUI view. When developing with it, you need to handle many aspects, including implementing various extensions and managing the view layer.

isle-editor's goal is to provide developers with a completely out-of-the-box rich text editor that can be quickly integrated into existing projects without complex configuration. We leveragetiptap's core implementation for its reliability while providingUI views and additional core extensions that enable out-of-the-box functionality through configuration.

You can useisle-editor in any framework and quickly integrate it into existing projects without complex configuration. (We prioritize support forVue views, with more framework views in development. You can also contribute your code onGitHub to help us implement view support for additional frameworks.)

isle-editor's core extensions are fully compatible withtiptap. If you're developing a project usingtiptap, you can seamlessly use our core extensions. You can also reference theisle-editor source code, as we aim for it to be a best practice implementation oftiptap.

• Ready to Use: Simple to integrate with just a few lines of code, no complex configuration needed.
• Extensible: Rich set of plug-and-play extensions and view components, with support for customization.
• Customizable: Supports custom theme styling, comes with built-in light and dark themes.
• Multilingual: Supports multilingual editing, with built-in English and Chinese support, extensible for more languages.
• Flexible: Supports various editing modes including block editing, rich text, WYSIWYG, Markdown, and Notion Style editing.
• High Performance: Built on ProseMirror and TipTap for smooth editing experience.

isle-editor is suitable for various scenarios:

• Content Creation: Blogs, documentation, notes, and other content creation scenarios
• Collaborative Editing: Team collaboration and real-time editing scenarios
• Rich Text Editing: Support for images, videos, tables, and other rich text content
• Custom Editors: Can be customized to create specialized editors for specific needs

Visit ouronline playground to quickly experience isle-editor in action.

isle-editor is open sourced software licensed under theMIT license.