tiptap/README.md
2024-01-18 18:13:33 +01:00

6.3 KiB

Tiptap Editor

The Tiptap open-source WYSIWYG Editor is a headless and framework-agnostic rich text editor based on ProseMirror. It is complemented by the collaboration open-source backend Hocuspocus. Both the Editor and Hocuspocus form the sturdy foundation of the Tiptap Suite.

Build Status Version Downloads License Chat Sponsor

Editor Features

  • Out-of-the-box text editing: Providing base editor functionality, ready for you to customize, extend and tailor to your application's needs.
  • Extension based: Extensions allow you to customize your Editor experience to your liking: From basic text styling capabilities to sophisticated notion-like drag and drop block editor capabilities. Integrate any of the over 100 extensions you can find in our documentation or community.
  • Infinitely flexible: The editor was built to give you full freedom to define your own extensions and nodes.

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, which allows multiple users to edit documents simultaneously, drag-and-drop file management for easier handling of documents and media, and unique node ID assignment. Review the docs right here.

Pro Extensions are free with a Tiptap account. Once signed up, review the guide in your account.

Make your editor collaborative

Interested in collaborative editing? Check out our open-source package Hocuspocus - a collaboration backend built around the 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

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

About Tiptap

At Tiptap we develop open-source products that also shape our paid features. We're committed to improving both, ensuring quality and reliability in every update.

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

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

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.