tiptap/docs/src/docPages/introduction.md

41 lines
2.8 KiB
Markdown
Raw Normal View History

2020-11-06 21:20:00 +08:00
---
2020-11-13 18:04:31 +08:00
title: Headless rich-text editor
2020-11-06 21:20:00 +08:00
---
2020-10-30 21:24:16 +08:00
:::error Dont try this at home
Nothing here is production-ready, dont use it anywhere.
2020-09-22 21:17:08 +08:00
:::
2020-04-20 05:50:55 +08:00
# Introduction
2020-09-22 21:17:08 +08:00
2020-10-30 21:24:16 +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) -->
<!-- [![Filesize](https://img.badgesize.io/https://unpkg.com/tiptap/dist/tiptap.min.js?compression=gzip&label=size&colorB=000000)](https://www.npmjs.com/package/tiptap) -->
<!-- [![Build Status](https://github.com/ueberdosis/tiptap-next/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap-next/actions) -->
2020-09-22 21:17:08 +08:00
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
2020-11-13 18:04:31 +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
2020-09-22 21:17:08 +08:00
Although tiptap tries to hide most of the complexity of ProseMirror, its built on top of its APIs and we recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/) for advanced usage. Youll have a better understanding of how everything works under the hood and get more familiar with many terms and jargon used by tiptap.
2020-04-20 05:50:55 +08:00
2020-09-21 23:50:50 +08:00
## Features
2020-08-28 19:20:49 +08:00
2020-11-13 18:04:31 +08:00
**Headless.** We dont tell you what a menu should look like or where it should be rendered in the DOM. Thats why tiptap is headless and comes without any CSS. You are in full control over markup and styling.
2020-09-21 23:50:50 +08:00
2020-10-30 23:13:47 +08:00
**Framework-agnostic.** We dont care what framework you use. tiptap is ready to be used with plain JavaScript or Vue.js. That makes it even possible to write a renderer for React, Svelte and others.
2020-09-21 23:50:50 +08:00
2020-10-30 23:13:47 +08:00
**TypeScript.** tiptap 2 is written in TypeScript. That gives you a nice autocomplete for the API (if your IDE supports that), helps to find bugs early and makes it possible to generate [a complete API documentation](#) on top of the extensive human written documentation.
## Who uses tiptap?
2020-04-20 05:50:55 +08:00
- [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)
2020-08-11 22:35:18 +08:00
- [and many more →](https://github.com/ueberdosis/tiptap/network/dependents?package_id=UGFja2FnZS0xMzE5OTg0ODc%3D)
2020-10-30 21:24:16 +08:00
## License
2020-10-30 23:13:47 +08:00
tiptap is licensed under MIT, so youre free to whatever you want. Anyway, we kindly ask you to [become a sponsor](https://github.com/sponsors/ueberdosis) on GitHub to fund the development, maintenance and support of tiptap.