tiptap/README.md

66 lines
3.0 KiB
Markdown
Raw Normal View History

2021-04-15 03:17:38 +08:00
# tiptap 2
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).
2021-04-15 03:17:38 +08:00
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)
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)
2021-04-29 04:25:15 +08:00
[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/WtJ49jGshW)
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)
2020-08-14 22:54:30 +08:00
2021-04-15 15:14:31 +08:00
> If youre looking for tiptap 1, [click here](https://github.com/ueberdosis/tiptap/tree/v1).
2021-02-09 00:46:24 +08:00
2021-04-15 03:17:38 +08:00
## Examples
2021-04-21 21:28:52 +08:00
Have a look at the [examples to see tiptap in action](https://www.tiptap.dev/examples).
2021-04-15 02:34:33 +08:00
2021-04-15 03:17:38 +08:00
## Documentation
2021-04-21 21:28:52 +08:00
The full documentation is a available on [www.tiptap.dev](https://www.tiptap.dev/installation).
2020-11-11 21:52:27 +08:00
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:
2020-09-22 21:45:32 +08:00
2021-04-15 03:17:38 +08:00
[Discuss tiptap on GitHub](https://github.com/ueberdosis/tiptap/discussions)
2021-04-15 03:17:38 +08:00
## 💖 Sponsors
2021-05-19 21:44:36 +08:00
* [überdosis](https://ueberdosis.io/) 🎁
2021-04-15 03:17:38 +08:00
* [Ziff Media Group](https://ziffmedia.com/)
* [Incyte Studios](https://incytestudios.com/)
* [dotCMS](http://dotcms.com/)
* [Restruct](https://restruct.nl/)
2021-04-21 21:22:45 +08:00
* [Bitcrowd](https://bitcrowd.net/)
2021-04-28 00:50:51 +08:00
* [Reflect](https://reflect.app/)
2021-05-19 21:43:54 +08:00
* [Rimsys](https://rimsys.io/) 💎
2021-05-19 21:47:28 +08:00
* [Complish](https://www.complish.app/) 💎
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/),
2021-04-15 03:21:12 +08:00
[IT Xpert](https://itxpert.ch/) and hundreds of awesome inviduals.
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)
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
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),
2021-04-15 03:21:12 +08:00
[Gregor](https://github.com/gambolputty) and [many more](../../contributors).
2020-11-11 21:52:27 +08:00
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.