tiptap/docs/introduction.md

22 lines
1.6 KiB
Markdown
Raw Normal View History

---
tableOfContents: true
---
2021-06-01 23:06:44 +08:00
# Introduction
2020-11-06 21:20:00 +08:00
2021-06-01 23:06:44 +08:00
## Whats tiptap?
2020-11-17 04:36:18 +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)
2020-11-17 22:02:56 +08:00
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
2020-09-22 21:17:08 +08:00
2020-11-17 04:36:18 +08:00
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*.
2020-04-20 05:50:55 +08:00
2021-04-16 03:48:19 +08:00
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. Its backed by a welcoming community, open source, and free.
2020-04-20 05:50:55 +08:00
2021-06-01 23:06:44 +08:00
## What does “headless” mean?
There is no provided user interface, you are absolutely free to build whatever interface you want. No need to overwrite any class, to use `!important` or other hacks, just write whatever you like in the setup you are used to.
2020-10-30 21:24:16 +08:00
2021-09-17 04:23:39 +08:00
## Why should I use tiptap?
[ProseMirror](https://ProseMirror.net) is a well-written, reliable and very powerful editor toolkit. Its not so much the ready-to-use editor most people look for, but with tiptap you can start in minutes, choose from tons of amazing extensions and still have that powerful ProseMirror API accessible when you really need it.