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)

components
Searching Database…

38.8K ·GitHub
What is this?Tiptap is a headless, framework-agnostic rich text editor framework for web apps, built on top of ProseMirror and extended through extensions.
What does 'headless' mean in practice — do I get an interface?No — it ships without any user interface, giving you full design freedom; if you want a jumpstart, there are linked UI templates. No CSS class overrides or hacks needed.
How do I add it to my project?Install the Tiptap npm packages and follow the docs quickstart for Vue, React or plain JavaScript (the tooling requires Node 24+). Ready-made examples and CodeSandboxes are there to fork.
Do I have to use a particular frontend framework with it?No — it is framework-agnostic and integrates with Vue, React or plain JavaScript without compatibility issues. Under the hood everything is based on the ProseMirror library.
What's the hardest part of using it?Building your own editor interface: Tiptap gives you the engine, not the looks, so all design work is on you. The linked UI templates help you start faster.
Is it actually free, or is there a paid side to it?The core editor is open source under the MIT license. The advanced Pro Extensions — collaboration, commenting, versioning, document conversion, AI features — and Tiptap Cloud require paid subscriptions.
Is collaborative editing built in?Through the companion open-source backend Hocuspocus, built around the CRDT power of Yjs — together with the editor it forms the Tiptap Suite. The README also links a collaboration-ready CodeSandbox to try it live.
What can I get out of the box from extensions?Over 100 extensions from the official docs and community, from simple text styling to advanced features like drag-and-drop block editing. You can also define your own extensions and nodes to tailor the editing experience.
Is there a ready Notion-style block editor example?Yes — the README links a React notion-like block editor template with a live demo, alongside a basic editor example and CodeSandboxes you can review and fork.
What are similar projects?BlockNote, ckeditor5, wangEditor, vditor, milkdown, lexical, slate, novel
Creator
ueberdosis
Size
87 MB
Stars
38.8K
Age
8y
Commits · 90 Days