mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2024-12-01 09:29:02 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
The headless rich text editor framework for web artisans.
841 Commits 53 Branches 5,440 Tags 71 MiB
TypeScript 97.7%
JavaScript 2.3%
8324f57528
Go to file
Philipp Kühn 8324f57528 add basic extension classes
2020-10-09 22:59:25 +02:00
.github add clean up script again (remove later) 2020-10-05 10:01:43 +02:00
docs add basic extension classes 2020-10-09 22:59:25 +02:00
packages add basic extension classes 2020-10-09 22:59:25 +02:00
shims improve eslint config 2020-09-24 09:35:18 +02:00
tests test bold and link regex 2020-10-08 14:39:44 +02:00
.editorconfig enable editorconfig for all files 2020-09-25 18:01:53 +02:00
.eslintignore fix lint error 2020-09-30 22:43:58 +02:00
.eslintrc.js fix lint error 2020-09-30 22:43:58 +02:00
.gitignore ignore cypress screenshots 2020-08-19 18:17:12 +02:00
babel.config.js fix optional chaining 2020-09-30 19:19:42 +02:00
CONTRIBUTING.md add basic README, LICENSE and CONTRIBUTING file 2020-09-15 21:16:05 +02:00
lerna.json initial commit 2019-12-07 21:02:22 +01:00
LICENSE.md add basic README, LICENSE and CONTRIBUTING file 2020-09-15 21:16:05 +02:00
package.json add babel core to mute a ton of warnings 2020-10-01 11:21:31 +02:00
README.md Update README.md 2020-10-01 09:25:37 +02:00
tsconfig.json fix optional chaining 2020-09-30 19:19:42 +02:00
yarn.lock rewrite yarn.lock 2020-10-02 17:24:19 +02:00

README.md

tiptap 2.x Preview

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

Build Status Sponsor

Roadmap

  • Proof of concept
  • Building out the editor
  • Adding a bunch of extensions
  • Creating a few examples
  • Giving sponsors access to gather feedback
  • Incorporate feedback
  • Publicly release version 2.0-beta
  • Squash bugs, build more extensions
  • Release version 2.0

Why we built tiptap

We were looking for a text editor for Vue.js 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, which impresses with its modularity. I came across 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?

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 by Adam Wathan.

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.

💖 Sponsor the development

Are you using tiptap in production? We need your sponsorship to maintain, update and develop tiptap. Become a Sponsor now!

Documentation

To check out some live examples, visit next.tiptap.dev.

Contributing

Please see CONTRIBUTING for details.

Credits

Related Projects