43 lines
3.1 KiB
Markdown
43 lines
3.1 KiB
Markdown
---
|
||
title: Headless rich text editor
|
||
---
|
||
|
||
:::error Work in progress
|
||
Nothing here is ready, don’t use it in production.
|
||
:::
|
||
|
||
# Introduction
|
||
[](https://www.npmjs.com/package/@tiptap/core)
|
||
[](https://npmcharts.com/compare/@tiptap/core?minimal=true)
|
||
[](https://www.npmjs.com/package/@tiptap/core)
|
||
[](https://github.com/sponsors/ueberdosis)
|
||
<!-- [](https://www.npmjs.com/package/tiptap) -->
|
||
<!-- [](https://github.com/ueberdosis/tiptap-next/actions) -->
|
||
|
||
tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
|
||
|
||
Create exactly the rich text editor you want out of customizable building blocks. tiptap comes with sensible defaults, a lot of extensions and a friendly API to customize every aspect. It’s backed by a welcoming community, open source, and free.
|
||
|
||
## Features
|
||
**Headless.** We don’t tell you what a menu should look like or where it should be rendered in the DOM. That’s why tiptap is headless and comes without any CSS. You are in full control over markup, styling and behaviour.
|
||
|
||
**Framework-agnostic.** No matter what framework you use, you’ll enjoy tiptap. Out of the box, it works with plain JavaScript and Vue.js, but it’s also possible to use it in React, Svelte and others.
|
||
|
||
**TypeScript.** tiptap 2 is written in TypeScript. That helps us to find bugs early and gives you a nice autocomplete for the API (if your IDE supports that) on top of the extensive human written documentation.
|
||
|
||
**Collaborative.** Real-time collaboration, syncing between different devices and working offline used to be hard. We provide everything you need to keep everything in sync, conflict-free with the power of [Y.js](https://github.com/yjs/yjs). Our production-grade setup requires less than 20 lines of code.
|
||
|
||
## Who uses tiptap?
|
||
- [GitLab](https://gitlab.com)
|
||
- [Statamic CMS](https://statamic.com)
|
||
- [Twill CMS](https://twill.io)
|
||
- [ApostropheCMS](https://apostrophecms.com)
|
||
- [Directus CMS](https://directus.io)
|
||
- [Nextcloud](https://apps.nextcloud.com/apps/text)
|
||
- [DocIQ](https://www.dociq.io)
|
||
- [Scrumpy](https://www.scrumpy.io)
|
||
- … and [many more](https://github.com/ueberdosis/tiptap/network/dependents?package_id=UGFja2FnZS0xMzE5OTg0ODc%3D)
|
||
|
||
## License
|
||
tiptap is licensed under [MIT](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md), so you’re free to do whatever you want. If you’re using it in production, do the right thing and [become one of our wonderful sponsors](/sponsor) to fund the development, maintenance and support of tiptap and the whole ecosystem.
|