tiptap/README.md

tiptap 2 (Sponsors preview!)

A headless and extendable rich text editor, based on ProseMirror, which is already in use at many well-known companies such as New York Times, The Guardian or Atlassian.

Feedback

We are looking for your feedback to improve tiptap 2 before the first public release! Share everything that helps to make it better for everyone!

• Create issues on GitHub! Link
• Send an email! humans@tiptap.dev
• Follow us on Twitter! @tiptap_editor @hanspagel @_philippkuehn

Why we built tiptap

We were looking for a text editor for Vue.js and found some solutions that didn’t really satisfy us. An editor should be easy to extend and not based on old dependencies such as jQuery. For React there is already a great editor called Slate.js, which impresses with its modularity. We came across ProseMirror and decided to build on it. ProseMirror is a toolkit for building rich text editors that are already in use at many well-known companies such as Atlassian or New York Times.

What does headless mean?

With headless components you'll have (almost) full control over markup and styling. We don’t want to tell you what a menu should look like or where it should be rendered in the DOM. That’s all up to you. There is also a great article about headless components by Adam Wathan.

How is the data stored under the hood?

You can save your data as a raw HTML string or can get a JSON-serializable representation of your document. And of course, you can also pass HTML or JSON content back to the editor.

💖 Sponsor the development

Are you using tiptap in production? We need your sponsorship to maintain, update and develop tiptap. Become a Sponsor now!

Documentation

To check out some live examples, visit next.tiptap.dev.

Contributing

Please see CONTRIBUTING for details.

Maintainers

• Philipp Kühn (developer)
• Hans Pagel (maintainer)

Premium Sponsors

• überdosis
• mymind
• DocIQ
• Apostrophe CMS
• Ycode
• @impactvelocity
• Flow Mobile

Credits

• Sam Willis
• Christoph Flathmann
• Erick Wilder
• Marius Tolzmann
• jjangga0214
• Maya Nedeljkovich
• Ryan Bliss
• Gregor
• All Contributors

Links

• https://github.com/ueberdosis/awesome-tiptap

Become a sponsor

Your benefits as a sponsor:

• Give back to the open source community
• Get early access to private repositories
• Ensure the further maintenace and development of tiptap
• Your issues and pull requests get a sponsor 💖 label
• Get a sponsor badge in all your comments on GitHub
• Show support in your GitHub profile
• Receive monthly reports about our open source work

Does that sound good? Become a sponsor!

License

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