tiptap/README.md
2021-08-24 13:32:28 +02:00

123 lines
5.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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 youre 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)
## Sponsors 💖
<table>
<tr>
<td align="center">
<a href="https://ueberdosis.io/">
<img src="https://unavatar.io/ueberdosis.io" width="100"><br>
<strong>überdosis</strong>
</a>
</td>
<td align="center">
<a href="https://rimsys.io/">
<img src="https://unavatar.io/github/rimsys" width="100"><br>
<strong>Rimsys</strong>
</a>
</td>
<td align="center">
<a href="https://www.cosmicmind.com/">
<img src="https://unavatar.io/github/cosmicmind" width="100"><br>
<strong>CosmicMind</strong>
</a>
</td>
<td align="center">
<a href="https://www.complish.app/">
<img src="https://uploads-ssl.webflow.com/5fa93d27380666789a1cbbd3/5fae50824b4d2d06f3d2898f_Frame%20374.png" width="100"><br>
<strong>Complish</strong>
</a>
</td>
<td align="center">
<a href="https://www.gamma.app/">
<img src="https://unavatar.io/gamma.app" width="100"><br>
<strong>Gamma</strong>
</a>
</td>
</tr>
</table>
<table>
<tr>
<td align="center" width="100">
<a href="https://reflect.app/">
<img src="https://unavatar.io/reflect.app" width="50"><br>
<strong>Reflect</strong>
</a>
</td>
<td align="center" width="100">
<a href="https://bitcrowd.net/">
<img src="https://unavatar.io/bitcrowd.net" width="50"><br>
<strong>Bitcrowd</strong>
</a>
</td>
<td align="center" width="100">
<a href="https://ziffmedia.com/">
<img src="https://unavatar.io/github/ziffmedia" width="50"><br>
<strong>Ziff Media</strong>
</a>
</td>
<td align="center" width="100">
<a href="https://incytestudios.com/">
<img src="https://unavatar.io/github/incyte" width="50"><br>
<strong>Incyte Studios</strong>
</a>
</td>
<td align="center" width="100">
<a href="https://restruct.nl/">
<img src="https://unavatar.io/github/restruct" width="50"><br>
<strong>restruct</strong>
</a>
</td>
<td align="center" width="100">
<a href="https://dotcms.com/">
<img src="https://unavatar.io/github/dotcms" width="50"><br>
<strong>dotCMS</strong>
</a>
</td>
</tr>
</table>
[iFixit](https://www.ifixit.com/), [@shodgson](https://github.com/shodgson), [Markee Co.](https://markee.io/), [Makelog](https://www.makelog.com/), [Zephir](https://zephir.ch/), [IT Xpert AG](https://itxpert.ch/), [ApostropheCMS](https://apostrophecms.com/), [Novadiscovery](http://www.novadiscovery.com/), [Omics Data Automation](https://www.omicsautomation.com), [Gretel](https://github.com/gretelapp#:~:text=http%3A//www.gretel.co), [Flow Mobile](https://www.flowmobile.app/), [Ycode](https://www.ycode.com/), [DocIQ](https://www.dociq.io/) and [hundreds of awesome inviduals](https://github.com/sponsors/ueberdosis).
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),
[Brian Hung](https://github.com/BrianHung),
[Dirk Holtwick](https://github.com/holtwick),
[Sam Duvall](https://github.com/SamDuvall),
[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.