restructuring

This commit is contained in:
Philipp Kühn
2020-04-24 10:03:15 +02:00
parent 397de08db0
commit 0f0b92b672
20 changed files with 4 additions and 23 deletions

View File

@@ -0,0 +1,23 @@
# Introduction
tiptap is a <g-link to="/renderless">renderless</g-link> wrapper around [ProseMirror](https://ProseMirror.net) a toolkit for building rich-text editors that are already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
Although tiptap tries to hide most of the complexity of ProseMirror, its is built on top of its APIs and we strongly recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/). Youll have a better understanding of how everything works under the hood and get familiar with many terms and jargon used by tiptap.
## Who is using tiptap already?
- [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)
- [and many more →](https://github.com/scrumpy/tiptap/network/dependents?package_id=UGFja2FnZS0xMzE5OTg0ODc%3D)
## Contributing
Please see the [`CONTRIBUTING.md`](https://github.com/scrumpy/tiptap/blob/master/CONTRIBUTING.md) file for details.
```bash
yarn install
yarn start
```