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 — это headless-фреймворк для богатого текстового редактора, не привязанный к конкретному фреймворку и предназначенный для веб-приложений. Он построен поверх ProseMirror и расширяется через расширения.
А что значит 'headless' на практике — интерфейс-то будет?Нет — пакет не содержит никакого интерфейса, так что дизайн полностью в ваших руках; если хочется стартовать быстрее, есть связанные UI-шаблоны. Никаких переопределений CSS-классов или хаков не потребуется.
Как добавить его в свой проект?Установите npm-пакеты Tiptap и следуйте инструкции быстрого старта из документации для Vue, React или чистого JavaScript (инструментам требуется Node 24+). Там же есть готовые примеры и CodeSandbox, которые можно склонировать себе.
Обязательно использовать с ним какой-то конкретный фронтенд-фреймворк?Нет — он не зависит от фреймворка и без проблем интегрируется с Vue, React или чистым JavaScript. Под капотом всё основано на библиотеке ProseMirror.
Что в нём самое сложное?Сделать собственный интерфейс редактора: Tiptap даёт движок, а не внешний вид, поэтому вся работа над дизайном — на вас. Связанные UI-шаблоны помогают начать быстрее.
Он вообще бесплатный или есть платная часть?Ядро редактора — открытый код под лицензией MIT. А продвинутые Pro Extensions — совместная работа, комментарии, версионирование, конвертация документов, функции с ИИ — и Tiptap Cloud требуют платных подписок.
Совместное редактирование уже встроено?Оно доступно через сопутствующий бэкенд с открытым кодом Hocuspocus, построенный вокруг CRDT-возможностей Yjs — вместе с редактором он образует Tiptap Suite. В README также есть ссылка на CodeSandbox с поддержкой совместной работы, чтобы попробовать вживую.
Что я получу из коробки благодаря расширениям?Больше 100 расширений из официальной документации и от сообщества — от простого оформления текста до продвинутых возможностей вроде редактирования блоков с помощью drag-and-drop. Можно также создавать свои расширения и узлы, чтобы настроить редактирование под себя.
Есть ли готовый пример блочного редактора в стиле Notion?Да — в README есть ссылка на шаблон блочного редактора notion-like для React с живой демо-версией, а также на пример простого редактора и CodeSandbox, которые можно посмотреть и склонировать.
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