tiptap/README.md

# tiptap 2
A headless, framework-agnostic and extendable rich text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror).

[![Build Status](https://github.com/ueberdosis/tiptap/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap/actions)
[![Version](https://img.shields.io/npm/v/@tiptap/core.svg?label=version)](https://www.npmjs.com/package/@tiptap/core)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/core.svg)](https://npmcharts.com/compare/@tiptap/core?minimal=true)
[![License](https://img.shields.io/npm/l/@tiptap/core.svg)](https://www.npmjs.com/package/@tiptap/core)
[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/WtJ49jGshW)
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)

> If you’re looking for tiptap 1, [click here](https://github.com/ueberdosis/tiptap/tree/v1).

## Examples
Have a look at the [examples to see tiptap in action](https://www.tiptap.dev/examples).

## Documentation
The full documentation is a available on [www.tiptap.dev](https://www.tiptap.dev/installation).

## Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:

[Discuss tiptap on GitHub](https://github.com/ueberdosis/tiptap/discussions)

For casual chit-chat with others using the framework:

[Join the tiptap Discord Server](https://discord.gg/WtJ49jGshW)

## 💖 Sponsors
* [überdosis](https://ueberdosis.io/)
* [Ziff Media Group](https://ziffmedia.com/)
* [Incyte Studios](https://incytestudios.com/)
* [dotCMS](http://dotcms.com/)
* [Restruct](https://restruct.nl/)
* [Bitcrowd](https://bitcrowd.net/)

[mymind](https://mymind.com/),
[DocIQ](https://www.dociq.io/),
[Apostrophe CMS](https://apostrophecms.com/),
[Ycode](https://www.ycode.com/),
[@impactvelocity](https://github.com/impactvelocity),
[Flow Mobile](https://www.flowmobile.app/),
[Gretel](http://www.gretel.co/),
[Omics Data Automation](https://www.omicsautomation.com/),
[Novadiscovery](http://www.novadiscovery.com/),
[Atlan Technologies](https://atlan.com/),
[Gamma](https://gamma.app/),
[Kirchner Consulting](https://kirchnerconsulting.ch/),
[IT Xpert](https://itxpert.ch/) and hundreds of awesome inviduals.

Using tiptap in production? Invest in the future of tiptap and [become a sponsor!](https://github.com/sponsors/ueberdosis)

## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Contributors
[Sam Willis](https://github.com/samwillis),
[Christoph Flathmann](https://github.com/Chrissi2812),
[Erick Wilder](https://github.com/erickwilder),
[Marius Tolzmann](https://github.com/mariux),
[jjangga0214](https://github.com/jjangga0214),
[Maya Nedeljkovich](https://github.com/mayacoda),
[Ryan Bliss](https://github.com/ryanbliss),
[Gregor](https://github.com/gambolputty) and [many more](../../contributors).

## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								# tiptap 2
-												Update README.md
											
										
										
											2021-04-15 03:22:42 +08:00
+								A headless, framework-agnostic and extendable rich text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror).
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
-												replace link to GitHub repository

											
										
										
											2021-04-21 21:31:11 +08:00
+								[![Build Status](https://github.com/ueberdosis/tiptap/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap/actions)
-												update the README

											
										
										
											2021-02-09 00:46:24 +08:00
+								[![Version](https://img.shields.io/npm/v/@tiptap/core.svg?label=version)](https://www.npmjs.com/package/@tiptap/core)
 								[![Downloads](https://img.shields.io/npm/dm/@tiptap/core.svg)](https://npmcharts.com/compare/@tiptap/core?minimal=true)
 								[![License](https://img.shields.io/npm/l/@tiptap/core.svg)](https://www.npmjs.com/package/@tiptap/core)
-												github: add a Discord badge

											
										
										
											2021-04-09 04:12:33 +08:00
+								[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/WtJ49jGshW)
-												Update README.md
											
										
										
											2021-04-15 02:33:40 +08:00
+								[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
-												update README

											
										
										
											2020-08-14 22:54:30 +08:00
-												update README.md

											
										
										
											2021-04-15 15:14:31 +08:00
+								> If you’re looking for tiptap 1, [click here](https://github.com/ueberdosis/tiptap/tree/v1).
-												update the README

											
										
										
											2021-02-09 00:46:24 +08:00
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								## Examples
-												replace primary domain

											
										
										
											2021-04-21 21:28:52 +08:00
+								Have a look at the [examples to see tiptap in action](https://www.tiptap.dev/examples).
-												Update README.md
											
										
										
											2021-04-15 02:34:33 +08:00
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								## Documentation
-												replace primary domain

											
										
										
											2021-04-21 21:28:52 +08:00
+								The full documentation is a available on [www.tiptap.dev](https://www.tiptap.dev/installation).
-												update README

											
										
										
											2020-11-11 21:52:27 +08:00
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								## Community
 								For help, discussion about best practices, or any other conversation that would benefit from being searchable:
-												add roadmap to the README

											
										
										
											2020-09-22 21:45:32 +08:00
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								[Discuss tiptap on GitHub](https://github.com/ueberdosis/tiptap/discussions)
-												add basic README, LICENSE and CONTRIBUTING file

											
										
										
											2020-09-16 03:16:05 +08:00
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								For casual chit-chat with others using the framework:
-												add basic README, LICENSE and CONTRIBUTING file

											
										
										
											2020-09-16 03:16:05 +08:00
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								[Join the tiptap Discord Server](https://discord.gg/WtJ49jGshW)
-												add basic README, LICENSE and CONTRIBUTING file

											
										
										
											2020-09-16 03:16:05 +08:00
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								## 💖 Sponsors
 								* [überdosis](https://ueberdosis.io/)
 								* [Ziff Media Group](https://ziffmedia.com/)
 								* [Incyte Studios](https://incytestudios.com/)
 								* [dotCMS](http://dotcms.com/)
 								* [Restruct](https://restruct.nl/)
-												add sponsor

											
										
										
											2021-04-21 21:22:45 +08:00
+								* [Bitcrowd](https://bitcrowd.net/)
-												add basic README, LICENSE and CONTRIBUTING file

											
										
										
											2020-09-16 03:16:05 +08:00
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								[mymind](https://mymind.com/),
 								[DocIQ](https://www.dociq.io/),
 								[Apostrophe CMS](https://apostrophecms.com/),
 								[Ycode](https://www.ycode.com/),
 								[@impactvelocity](https://github.com/impactvelocity),
 								[Flow Mobile](https://www.flowmobile.app/),
 								[Gretel](http://www.gretel.co/),
 								[Omics Data Automation](https://www.omicsautomation.com/),
 								[Novadiscovery](http://www.novadiscovery.com/),
 								[Atlan Technologies](https://atlan.com/),
 								[Gamma](https://gamma.app/),
 								[Kirchner Consulting](https://kirchnerconsulting.ch/),
-												update README.md

											
										
										
											2021-04-15 03:21:12 +08:00
+								[IT Xpert](https://itxpert.ch/) and hundreds of awesome inviduals.
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
 								Using tiptap in production? Invest in the future of tiptap and [become a sponsor!](https://github.com/sponsors/ueberdosis)
-												add basic README, LICENSE and CONTRIBUTING file

											
										
										
											2020-09-16 03:16:05 +08:00
 								## Contributing
 								Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
-												update README.md

											
										
										
											2021-04-15 03:17:38 +08:00
+								## Contributors
 								[Sam Willis](https://github.com/samwillis),
 								[Christoph Flathmann](https://github.com/Chrissi2812),
 								[Erick Wilder](https://github.com/erickwilder),
 								[Marius Tolzmann](https://github.com/mariux),
 								[jjangga0214](https://github.com/jjangga0214),
 								[Maya Nedeljkovich](https://github.com/mayacoda),
 								[Ryan Bliss](https://github.com/ryanbliss),
-												update README.md

											
										
										
											2021-04-15 03:21:12 +08:00
+								[Gregor](https://github.com/gambolputty) and [many more](../../contributors).
-												update README

											
										
										
											2020-11-11 21:52:27 +08:00
 								## License
 								The MIT License (MIT). Please see [License File](LICENSE.md) for more information.