tiptap/README.md

111 lines
6.3 KiB
Markdown
Raw Normal View History

2024-01-19 01:13:33 +08:00
# Tiptap Editor
The Tiptap open-source WYSIWYG Editor is a headless and framework-agnostic rich text editor based on [ProseMirror](https://github.com/ProseMirror/prosemirror).
It is complemented by the collaboration open-source backend [Hocuspocus](https://github.com/ueberdosis/hocuspocus). Both the Editor and Hocuspocus form the sturdy foundation of the [Tiptap Suite](https://tiptap.dev/).
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
2024-01-19 01:13:33 +08:00
### Editor Features
- **Out-of-the-box text editing:** Providing base editor functionality, ready for you to customize, extend and tailor to your application's needs.
- **Extension based:** Extensions allow you to customize your Editor experience to your liking: From basic text styling capabilities to sophisticated notion-like drag and drop block editor capabilities. Integrate any of the over 100 extensions you can find in our [documentation](https://tiptap.dev/docs/editor/extensions) or [community](https://github.com/ueberdosis/awesome-tiptap/#community-extensions).
- **Infinitely flexible:** The editor was built to give you full freedom to define your own [extensions](https://tiptap.dev/docs/editor/guide/custom-extensions) and [nodes](https://tiptap.dev/docs/editor/api/nodes).
### Editor Pro Extensions
The Pro Extensions are a set of advanced functionalities that enhance the capabilities of the Tiptap Editor. They are additional features that can be integrated into the base editor to provide more sophisticated editing options.
Key functionalities include collaborative editing, which allows multiple users to edit documents simultaneously, drag-and-drop file management for easier handling of documents and media, and unique node ID assignment. Review the docs right [here](https://tiptap.dev/docs/editor/extensions).
Pro Extensions are free with a [Tiptap account](https://cloud.tiptap.dev/pro-extensions). Once signed up, review the guide in your account.
### Make your editor collaborative
Interested in collaborative editing? Check out our open-source package [Hocuspocus](https://github.com/ueberdosis/hocuspocus) - a collaboration backend built around the power of [Yjs](https://github.com/yjs/yjs). Hocuspocus serves as the backbone for the [Tiptap Suite](https://tiptap.dev/).
2021-04-15 02:34:33 +08:00
2021-04-15 03:17:38 +08:00
## Documentation
2024-01-19 01:13:33 +08:00
For more detailed information, make sure to check out our [documentation](https://tiptap.dev/docs/editor/installation). If you encounter any problems or have suggestions for our system, please open an issue.
### Examples & CodeSandbox
Have a look at the [examples to see Tiptap in action](https://tiptap.dev/examples) or review and fork our codesandboxes.
- [Basic example of the Tiptap editor.](https://codesandbox.io/p/devbox/editor-9x9dkd?embed=1&file=%2Fsrc%2FApp.js)
- [Collaboration ready Tiptap CodeSandbox](https://codesandbox.io/p/devbox/collaboration-4stk94)
- React notion-like block editor template: [Demo](https://templates.tiptap.dev/)
2020-11-11 21:52:27 +08:00
2024-01-19 01:13:33 +08:00
## About Tiptap
At Tiptap we develop open-source products that also shape our paid features. We're committed to improving both, ensuring quality and reliability in every update.
### Community
2021-04-15 03:17:38 +08:00
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)
2024-01-19 01:13:33 +08:00
### Sponsors 💖
2021-08-24 19:31:16 +08:00
<table>
<tr>
<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>
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>
2023-12-20 02:33:19 +08:00
</td>
<td align="center">
<a href="https://posthog.com/">
<img src="https://unavatar.io/github/posthog" width="100"><br>
<strong>PostHog</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://reflect.app/">
2024-01-19 01:13:33 +08:00
<img src="https://unavatar.io/reflect.app" width="100"><br>
2021-08-24 19:31:16 +08:00
<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://ziffmedia.com/">
2024-01-19 01:13:33 +08:00
<img src="https://unavatar.io/github/ziffmedia" width="100"><br>
2021-08-24 19:31:16 +08:00
<strong>Ziff Media</strong>
</a>
</td>
2023-06-07 17:54:02 +08:00
<td align="center" width="100">
<a href="https://www.basewell.com/">
2024-01-19 01:13:33 +08:00
<img src="https://unavatar.io/github/Basewell" width="100"><br>
2023-06-07 17:54:02 +08:00
<strong>Basewell</strong>
</a>
</td>
2021-08-24 19:31:16 +08:00
</tr>
</table>
2024-01-19 01:13:33 +08:00
<table>
</table>
2021-04-15 03:17:38 +08:00
2024-01-19 01:13:33 +08:00
[iFixit](https://www.ifixit.com/), [ApostropheCMS](https://apostrophecms.com/), [Novadiscovery](http://www.novadiscovery.com/), [Omics Data Automation](https://www.omicsautomation.com), [Flow Mobile](https://www.flowmobile.app/), [DocIQ](https://www.dociq.io/) and [hundreds of awesome inviduals](https://github.com/sponsors/ueberdosis).
2024-01-19 01:13:33 +08:00
### Contributing
Feel like adding some magic of your own to Tiptap Editor Core? We welcome contributions! Please see our [CONTRIBUTING](CONTRIBUTING.md) guidelines for how to get started.
2024-01-19 01:13:33 +08:00
### Contributors
2021-04-15 03:17:38 +08:00
[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.