ueberdosis / tiptap
git clone https://github.com/ueberdosis/tiptap.git
v3.32.0 · 10d ago
The headless rich text editor framework for web artisans.
+8
stars, 24h · #4,352
+~70
stars, 7 days · #3,003
+~300
stars, 30 days · #2,726
39k
★ total · +0% this week
3.2k
forks · 915 open issues
Star history (as recorded here)
LanguageTypeScript
LicenseMIT
Created2018-08-20 (8y ago)
Last push1d ago
Watchers175
OwnerOrganization
GitHub topics
Links
- GitHub: github.com/ueberdosis/tiptap
- Homepage: https://tiptap.dev
- Releases · Issues · Hacker News mentions
README excerpt
# Tiptap Editor The Tiptap Editor is a headless, framework-agnostic rich text editor that's customizable and extendable through extensions. Its headless nature means it comes without a set user interface, offering full design freedom (for a jumpstart, see linked UI templates below). Tiptap is based on the highly reliable ProseMirror library. Tiptap Editor is complemented by the collaboration open-source backend Hocuspocus. Both the Editor and Hocuspocus form the foundation of the Tiptap Suite. ### How does the Tiptap Editor work? - **Headless Framework:** Tiptap does not rely on a user interface. So there is no need for class overrides or code hacks. If you do need an example UI feel free to browse our UI templates linked below. - **Framework-agnostic:** The Tiptap Editor is designed to work across different frontend frameworks. This means whether you're using Vue, React, or plain JavaScript, Tiptap integrates without compatibility issues. - **Extension based:** Extensions in Tiptap allow for a tailored editing experience, from simple text styling to advanced features like drag-and-drop block editing. You have the option to choose from over 100 extensions available in the documentation and community to enhance your editor's functionality. - **Customize your UX:** The editor was built to give you control to define your own extensions and nodes. ### Editor Pro Extensions The **Pro Extensions** are a set of advanced functionalities that enhance the capabilities of the Tiptap Editor. They are additional features that can be integrated into the base editor to provide more sophisticated editing options. Key functionalities include collaborative editing, commenting, versioning, document conversion and AI related features. Review the docs right here. Pro Extensions need a valid subscription. ### Make your editor collaborative Interested in collaborative editing? Check out our open-source package Hocuspocus - a collaboration backend built around the CRDT power of Yjs. Hocuspocus serves as the backbone for the Tiptap Suite. ## Documentation For more detailed information, make sure to check out our documentation. If you encounter any problems or have suggestions for our system, please open an issue. ### Examples, CodeSandbox and UI Templates Have a look at the examples to see Tiptap in action or review and fork our codesandboxes. - Basic example of the Tiptap editor. - Collaboration ready Tiptap CodeSandbox - React notion-like block editor template: Demo ## Agent skill Install the Tiptap skill in your application project to help coding agents set up, extend, and debug your editor: [code] ## About Tiptap Tiptap is a collection of developer components based on open-source technology, forming the basis of our advanced, paid features. It includes the open-source editor component, collaboration features, Content AI, and Tiptap Cloud. We are developing open-source products that also shape our paid features. We're committed to improving both, ensuring quality an