tiptap/README.md

115 lines
4.7 KiB
Markdown
Raw Normal View History

2021-10-22 16:06:35 +08:00
# Tiptap
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 03:17:38 +08:00
## Examples
2023-03-27 17:20:31 +08:00
Have a look at the [examples to see Tiptap in action](https://tiptap.dev/examples).
2021-04-15 02:34:33 +08:00
2021-04-15 03:17:38 +08:00
## Documentation
The full documentation is available on [www.tiptap.dev](https://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
2023-03-27 17:20:31 +08:00
[Discuss Tiptap on GitHub](https://github.com/ueberdosis/tiptap/discussions)
2021-08-24 19:31:16 +08:00
## Sponsors 💖
<table>
<tr>
<td align="center">
<a href="https://ueberdosis.io/">
2021-11-24 03:43:43 +08:00
<img src="https://unavatar.io/github/ueberdosis" width="100"><br>
2021-08-24 19:31:16 +08:00
<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.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>
2021-10-07 03:03:24 +08:00
<td align="center">
<a href="https://www.storyblok.com/">
<img src="https://unavatar.io/github/storyblok" width="100"><br>
<strong>Storyblok</strong>
</a>
</td>
2021-08-24 19:31:16 +08:00
</tr>
</table>
2021-08-24 19:31:16 +08:00
<table>
<tr>
2021-08-24 19:32:28 +08:00
<td align="center" width="100">
2021-08-24 19:31:16 +08:00
<a href="https://reflect.app/">
<img src="https://unavatar.io/reflect.app" width="50"><br>
<strong>Reflect</strong>
</a>
</td>
2021-08-24 19:32:28 +08:00
<td align="center" width="100">
2021-08-24 19:31:16 +08:00
<a href="https://bitcrowd.net/">
<img src="https://unavatar.io/bitcrowd.net" width="50"><br>
<strong>Bitcrowd</strong>
</a>
</td>
2021-08-24 19:32:28 +08:00
<td align="center" width="100">
2021-08-24 19:31:16 +08:00
<a href="https://ziffmedia.com/">
<img src="https://unavatar.io/github/ziffmedia" width="50"><br>
<strong>Ziff Media</strong>
</a>
</td>
2021-08-24 19:32:28 +08:00
<td align="center" width="100">
2021-08-24 19:31:16 +08:00
<a href="https://incytestudios.com/">
<img src="https://unavatar.io/github/incyte" width="50"><br>
<strong>Incyte Studios</strong>
</a>
</td>
2021-08-24 19:32:28 +08:00
<td align="center" width="100">
2021-08-24 19:31:16 +08:00
<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).
2021-04-15 03:17:38 +08:00
2023-03-27 17:20:31 +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),
2021-08-24 19:31:16 +08:00
[Brian Hung](https://github.com/BrianHung),
[Dirk Holtwick](https://github.com/holtwick),
[Sam Duvall](https://github.com/SamDuvall),
2021-04-15 03:17:38 +08:00
[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.