tiptap README

The project's README from github.com/ueberdosis/tiptap. As one markdown file: README.md.

Tiptap Editor

LFX Health Score Build Status Version Downloads License Chat Sponsor LFX Active Contributors

Tiptap Editor

The Tiptap Editor is a headless, framework-agnostic rich text editor that's customizable and extendable through extensions. Its headless nature means it comes without a set user interface, offering full design freedom (for a jumpstart, see linked UI templates below). Tiptap is based on the highly reliable ProseMirror library.

Tiptap Editor is complemented by the collaboration open-source backend Hocuspocus. Both the Editor and Hocuspocus form the foundation of the Tiptap Suite.

How does the Tiptap Editor work?

Editor Pro Extensions

The Pro Extensions are a set of advanced functionalities that enhance the capabilities of the Tiptap Editor. They are additional features that can be integrated into the base editor to provide more sophisticated editing options.

Key functionalities include collaborative editing, commenting, versioning, document conversion and AI related features. Review the docs right here.

Pro Extensions need a valid subscription.

Make your editor collaborative

Interested in collaborative editing? Check out our open-source package Hocuspocus - a collaboration backend built around the CRDT power of Yjs. Hocuspocus serves as the backbone for the Tiptap Suite.

Documentation

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

Examples, CodeSandbox and UI Templates

Have a look at the examples to see Tiptap in action or review and fork our codesandboxes.

About Tiptap

Tiptap is a collection of developer components based on open-source technology, forming the basis of our advanced, paid features. It includes the open-source editor component, collaboration features, Content AI, and Tiptap Cloud. We are developing open-source products that also shape our paid features. We're committed to improving both, ensuring quality and reliability in every update.

For more details, visit the Tiptap documentation or website.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discuss Tiptap on GitHub

Sponsors 💖


Complish

Storyblok

PostHog

Reflect

Ziff Media

Basewell

Poggio

iFixit, ApostropheCMS, Novadiscovery, Omics Data Automation, Flow Mobile, DocIQ and hundreds of awesome individuals.

Contributing

Feel like adding some magic of your own to Tiptap Editor Core? We welcome contributions! Please see our CONTRIBUTING guidelines for how to get started.

Contributors

Sam Willis, Brian Hung, Dirk Holtwick, Sam Duvall, Christoph Flathmann, Erick Wilder, Marius Tolzmann, jjangga0214, Maya Nedeljkovich, Ryan Bliss, Gregor and many more.

License

The MIT License (MIT). Please see License File for more information.

tiptap (ueberdosis/tiptap)

Searching Database…

38.8K ·GitHub
这是什么?Tiptap 是一个无界面、不依赖特定框架的富文本编辑器框架,面向 Web 应用,基于 ProseMirror 构建,并通过扩展来增强功能。
“无界面”到底是什么意思——我能拿到现成的界面吗?不能——它本身不带任何用户界面,让你在设计上完全自由;如果想快速起步,官方提供了配套的 UI 模板。不需要覆盖 CSS 类或用任何 hack。
怎么把它加到我的项目里?安装 Tiptap 的 npm 包,然后按照文档的快速上手指南来接入 Vue、React 或纯 JavaScript(相关工具链需要 Node 24+)。文档里还有现成的示例和 CodeSandbox 可以直接 fork。
我必须搭配某个特定的前端框架使用吗?不用——它不挑框架,可以无缝集成 Vue、React 或纯 JavaScript,没有任何兼容性问题。底层一切都是基于 ProseMirror 这个库实现的。
用它最难的地方是什么?自己搭建编辑器界面:Tiptap 给你的是引擎,不是外观,所以所有设计工作都得自己来。配套的 UI 模板能帮你更快上手。
它是真免费,还是有收费的部分?核心编辑器是开源的,采用 MIT 许可证。高级的 Pro 扩展——协作、评论、版本管理、文档转换、AI 功能——以及 Tiptap Cloud 都需要付费订阅。
协同编辑是内置的吗?要借助配套的开源后端 Hocuspocus,它建立在 Yjs 的 CRDT 能力之上——和编辑器一起组成了 Tiptap Suite。README 里还链接了一个支持协作的 CodeSandbox,可以在线试用。
扩展开箱能提供哪些功能?官方文档和社区提供了 100 多个扩展,从简单的文字样式到拖拽式块编辑这类高级功能都有。你也可以自定义扩展和节点,按自己的需求定制编辑体验。
有没有现成的 Notion 风格块编辑器示例?有——README 链接了一个 React 的 notion 风格块编辑器模板,带在线演示,另外还有基础编辑器示例和可以查看、fork 的 CodeSandbox。
What are similar projects?BlockNote, ckeditor5, wangEditor, vditor, milkdown, lexical, slate, novel
Creator
ueberdosis
Size
87.1 MB
Stars
38.8K
Age
8y
Commits · 90 Days