mirror of
https://github.com/ueberdosis/tiptap.git
synced 2025-01-18 06:03:22 +08:00
update README
This commit is contained in:
parent
f6fa9ae087
commit
e1a2a14db4
54
README.md
54
README.md
@ -1,7 +1,8 @@
|
|||||||
# tiptap 2.x Preview
|
> Don’t try this at home! Nothing here is production-ready, don’t use it anywhere.
|
||||||
> Don’t use this in production. It’s full of bugs and the API will likely change.
|
|
||||||
|
|
||||||
A renderless and extendable rich-text editor for [Vue.js](https://github.com/vuejs/vue)
|
# tiptap 2 (Preview!)
|
||||||
|
|
||||||
|
A renderless and extendable rich-text editor, based on [ProseMirror](https://github.com/ProseMirror/prosemirror), which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
|
||||||
|
|
||||||
<!-- [![Version](https://img.shields.io/npm/v/tiptap.svg?label=version)](https://www.npmjs.com/package/tiptap)
|
<!-- [![Version](https://img.shields.io/npm/v/tiptap.svg?label=version)](https://www.npmjs.com/package/tiptap)
|
||||||
[![Downloads](https://img.shields.io/npm/dm/tiptap.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
|
[![Downloads](https://img.shields.io/npm/dm/tiptap.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
|
||||||
@ -10,25 +11,21 @@ A renderless and extendable rich-text editor for [Vue.js](https://github.com/vue
|
|||||||
[![Build Status](https://github.com/ueberdosis/tiptap-next/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap-next/actions)
|
[![Build Status](https://github.com/ueberdosis/tiptap-next/workflows/build/badge.svg)](https://github.com/ueberdosis/tiptap-next/actions)
|
||||||
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
|
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
|
||||||
|
|
||||||
## Roadmap
|
## Feedback
|
||||||
- [x] Proof of concept
|
We’re looking for your feedback to improve tiptap 2 before the first public release! Share everything that helps to make it better for everyone!
|
||||||
- [x] Building out the editor
|
|
||||||
- [x] Adding a bunch of extensions
|
* Create issues on GitHub! [Link](https://github.com/ueberdosis/tiptap-next/issues)
|
||||||
- [x] Creating a few examples
|
* Send an email! [hans.pagel@ueber.io](mailto:hans.pagel@ueber.io)
|
||||||
- [ ] Giving sponsors access to gather feedback
|
* Follow us on Twitter! [@hanspagel](https://twitter.com/hanspagel) [@_philippkuehn](https://twitter.com/_philippkuehn)
|
||||||
- [ ] Incorporate feedback
|
|
||||||
- [ ] Publicly release version 2.0-beta
|
|
||||||
- [ ] Squash bugs, build more extensions
|
|
||||||
- [ ] Release version 2.0
|
|
||||||
|
|
||||||
## Why we built tiptap
|
## Why we built tiptap
|
||||||
We were looking for a text editor for [Vue.js](https://github.com/vuejs/vue) and found some solutions that didn’t really satisfy me. The editor should be easy to extend and not based on old dependencies such as jQuery. For React there is already a great editor called [Slate.js](https://github.com/ianstormtaylor/slate), which impresses with its modularity. I came across [ProseMirror](https://github.com/prosemirror) and decided to build on it. ProseMirror is a toolkit for building rich-text editors that are already in use at many well-known companies such as *Atlassian* or *New York Times*.
|
We were looking for a text editor for [Vue.js](https://github.com/vuejs/vue) and found some solutions that didn’t really satisfy us. An editor should be easy to extend and not based on old dependencies such as jQuery. For React there is already a great editor called [Slate.js](https://github.com/ianstormtaylor/slate), which impresses with its modularity. We came across [ProseMirror](https://github.com/prosemirror) and decided to build on it. ProseMirror is a toolkit for building rich-text editors that are already in use at many well-known companies such as *Atlassian* or *New York Times*.
|
||||||
|
|
||||||
### What does `renderless` mean?
|
### What does `renderless` mean?
|
||||||
With renderless components you'll have (almost) full control over markup and styling. We don’t want to tell you what a menu should look like or where it should be rendered in the DOM. That’s all up to you. There is also a [great article about renderless components](https://adamwathan.me/renderless-components-in-vuejs/) by Adam Wathan.
|
With renderless components you'll have (almost) full control over markup and styling. We don’t want to tell you what a menu should look like or where it should be rendered in the DOM. That’s all up to you. There is also a [great article about renderless components](https://adamwathan.me/renderless-components-in-vuejs/) by Adam Wathan.
|
||||||
|
|
||||||
### How is the data stored under the hood?
|
### How is the data stored under the hood?
|
||||||
You can save your data as a raw `HTML` string or can get a `JSON`-serializable representation of your document. And of course, you can pass these two types back to the editor.
|
You can save your data as a raw `HTML` string or can get a `JSON`-serializable representation of your document. And of course, you can also pass `HTML` or `JSON` content back to the editor.
|
||||||
|
|
||||||
## 💖 Sponsor the development
|
## 💖 Sponsor the development
|
||||||
Are you using tiptap in production? We need your sponsorship to maintain, update and develop tiptap. [Become a Sponsor now!](https://github.com/sponsors/ueberdosis)
|
Are you using tiptap in production? We need your sponsorship to maintain, update and develop tiptap. [Become a Sponsor now!](https://github.com/sponsors/ueberdosis)
|
||||||
@ -39,12 +36,33 @@ To check out some live examples, visit [next.tiptap.dev](https://next.tiptap.dev
|
|||||||
## Contributing
|
## Contributing
|
||||||
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
|
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
|
||||||
|
|
||||||
|
## Maintainers
|
||||||
|
- [Philipp Kühn](https://github.com/philippkuehn) (development)
|
||||||
|
- [Hans Pagel](https://github.com/hanspagel) (documentation)
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
- [Philipp Kühn](https://github.com/philippkuehn)
|
- [Christoph Flathmann](https://github.com/Chrissi2812)
|
||||||
- [Hans Pagel](https://github.com/hanspagel)
|
- [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)
|
||||||
|
- [Gregor](https://github.com/gambolputty)
|
||||||
- [All Contributors](../../contributors)
|
- [All Contributors](../../contributors)
|
||||||
|
|
||||||
## Related Projects
|
## Related Projects
|
||||||
- [prosemirror-php](https://github.com/ueberdosis/prosemirror-php) by @hanspagel
|
|
||||||
- [html-to-prosemirror](https://github.com/ueberdosis/html-to-prosemirror) by @hanspagel
|
- [html-to-prosemirror](https://github.com/ueberdosis/html-to-prosemirror) by @hanspagel
|
||||||
- [prosemirror-to-html](https://github.com/ueberdosis/prosemirror-to-html) by @hanspagel
|
- [prosemirror-to-html](https://github.com/ueberdosis/prosemirror-to-html) by @hanspagel
|
||||||
|
- [tiptap-svelte](https://github.com/andrewjk/tiptap-svelte) by @andrewjk
|
||||||
|
- [Laravel Nova Tiptap Editor Field](https://github.com/manogi/nova-tiptap) by @manogi
|
||||||
|
- [WYSIWYG editor for Vuetify](https://github.com/iliyaZelenko/tiptap-vuetify) by @iliyaZelenko
|
||||||
|
- [Quasar Tiptap Demo](https://github.com/kfields/quasar-tiptap-demo) @kfields
|
||||||
|
- [Python Library that converts tiptap JSON](https://github.com/scrolltech/tiptapy) @scrolltech
|
||||||
|
- [WYSIWYG editor for Element UI](https://github.com/Leecason/element-tiptap) by @Leecason
|
||||||
|
- [WYSIWYG editor for Quasar Framework](https://github.com/donotebase/quasar-tiptap) by @mekery
|
||||||
|
|
||||||
|
## Love our work?
|
||||||
|
[Sponsor us](https://github.com/sponsors/ueberdosis) ❤️
|
||||||
|
|
||||||
|
## License
|
||||||
|
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|
||||||
|
Loading…
Reference in New Issue
Block a user