tiptap/README.md
2020-11-11 15:12:59 +01:00

4.7 KiB
Raw Blame History

Dont try this at home! Nothing here is production-ready, dont use it anywhere.

tiptap 2 (Preview!)

A renderless 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.

Build Status Sponsor

Feedback

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

Why we built tiptap

We were looking for a text editor for Vue.js and found some solutions that didnt 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 renderless mean?

With renderless components you'll have (almost) full control over markup and styling. We dont want to tell you what a menu should look like or where it should be rendered in the DOM. Thats all up to you. There is also a great article about renderless 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

Premium Sponsors

Credits

Love our work?

Sponsor us ❤️

License

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