diff --git a/docs/about.md b/docs/about.md index 590c512a..1bed4585 100644 --- a/docs/about.md +++ b/docs/about.md @@ -5,7 +5,7 @@ tableOfContents: true # About the project ## Introduction -To deliver a top-notch developer experience and user experience, we put ~~hundreds~~ thousands of hours of unpaid work into tiptap. Your funding helps us to make this work more and more financially sustainable. This enables us to provide helpful support, maintain all our packages, keep everything up to date, and develop new features and extensions for tiptap. +To deliver a top-notch developer experience and user experience, we put ~~hundreds~~ thousands of hours of unpaid work into Tiptap. Your funding helps us to make this work more and more financially sustainable. This enables us to provide helpful support, maintain all our packages, keep everything up to date, and develop new features and extensions for Tiptap. Give back to the open source community and [sponsor us on GitHub](https://github.com/sponsors/ueberdosis)! ♥ @@ -13,27 +13,27 @@ Give back to the open source community and [sponsor us on GitHub](https://github * Get early access to private repositories * Your issues and pull requests get a `sponsor ♥` label * Get a sponsor badge in all your comments on GitHub -* Invest in the future of tiptap +* Invest in the future of Tiptap * Give back to the open source community * Show support in your GitHub profile Sounds good? [Sponsor us on GitHub!](https://github.com/sponsors/ueberdosis) -## The maintainers of tiptap -If you are thankful for tiptap, you should say thank you to the lovely people of [überdosis](https://ueberdosis.io). The amazing company we are all building together and the amazing company that funded the initial development costs of tiptap. +## The maintainers of Tiptap +If you are thankful for Tiptap, you should say thank you to the lovely people of [überdosis](https://ueberdosis.io). The amazing company we are all building together and the amazing company that funded the initial development costs of Tiptap. AND you should definitely hire us if you want us to design und build an amazing digital product for you. Bonus points if it’s somehow text editing related. -But here are the friendly faces of the two maintainers of tiptap, Philipp Kühn (left) and Hans Pagel (right). You’ve probably read our names in the thousands of commits, pull requests or Tweets already. +But here are the friendly faces of the two maintainers of Tiptap, Philipp Kühn (left) and Hans Pagel (right). You’ve probably read our names in the thousands of commits, pull requests or Tweets already. -![Philipp and Hans, the maintainers of tiptap, looking happy](/philipp-and-hans.jpg) +![Philipp and Hans, the maintainers of Tiptap, looking happy](/philipp-and-hans.jpg) ## More peace of mind -Companies betting on tiptap probably want some peace of mind and ensure that we keep maintaining tiptap, but don’t forget that our work is based on the work of other lovely people that you should definitely sponsor too: +Companies betting on Tiptap probably want some peace of mind and ensure that we keep maintaining Tiptap, but don’t forget that our work is based on the work of other lovely people that you should definitely sponsor too: * [Sponsor Marijn Haverbeke](https://marijnhaverbeke.nl/fund/) (ProseMirror) * [Sponsor Kevin Jahns](https://github.com/sponsors/dmonad) (Y.js) -* [Sponsor Y-Collective](https://opencollective.com/y-collective) (Y.js + tiptap) +* [Sponsor Y-Collective](https://opencollective.com/y-collective) (Y.js + Tiptap) ## Frequently asked questions @@ -46,4 +46,4 @@ We are part of the [Y-Collective](https://opencollective.com/y-collective), a fu If you have an issue, a question, want to talk something through or anything else, [please use GitHub issues](https://github.com/ueberdosis/tiptap/issues/new/choose) to keep everything accessible to the whole community. For everything else, reach out to [humans@tiptap.dev](mailto:humans@tiptap.dev). We can take on a limited number of custom development and consulting contracts. ### Can we have a call? -Nope, we are big fans of asynchronous communication. If you really need to reach out in private, send us an email to [humans@tiptap.dev](mailto:humans@tiptap.dev), but don’t expect technical email support. That all happens on [GitHub](https://github.com/ueberdosis/tiptap/issues) \ No newline at end of file +Nope, we are big fans of asynchronous communication. If you really need to reach out in private, send us an email to [humans@tiptap.dev](mailto:humans@tiptap.dev), but don’t expect technical email support. That all happens on [GitHub](https://github.com/ueberdosis/tiptap/issues) diff --git a/docs/api/commands.md b/docs/api/commands.md index 9122c464..b9410332 100644 --- a/docs/api/commands.md +++ b/docs/api/commands.md @@ -105,7 +105,7 @@ export default (value) => ({ tr, dispatch }) => { } ``` -If you’re just wrapping another tiptap command, you don’t need to check that, we’ll do it for you. +If you’re just wrapping another Tiptap command, you don’t need to check that, we’ll do it for you. ```js addCommands() { @@ -272,7 +272,7 @@ But how do you write those commands? There’s a little bit to learn about that. :::pro Oops, this is work in progress A well-written documentation needs attention to detail, a great understanding of the project and time to write. -Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! With nearly 300 sponsors we are half way there already. +Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! With nearly 300 sponsors we are half way there already. Join them and become a sponsor! Enable us to put more time into open source and we’ll fill this page and keep it up to date for you. diff --git a/docs/api/commands/create-paragraph-near.md b/docs/api/commands/create-paragraph-near.md index 96d1d0f2..95836c32 100644 --- a/docs/api/commands/create-paragraph-near.md +++ b/docs/api/commands/create-paragraph-near.md @@ -1,5 +1,5 @@ # createParagraphNear :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/delete-node.md b/docs/api/commands/delete-node.md index 72711e0f..b2940dfc 100644 --- a/docs/api/commands/delete-node.md +++ b/docs/api/commands/delete-node.md @@ -1,5 +1,5 @@ # deleteNode :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/delete-range.md b/docs/api/commands/delete-range.md index 6b364c4f..13d4e272 100644 --- a/docs/api/commands/delete-range.md +++ b/docs/api/commands/delete-range.md @@ -1,5 +1,5 @@ # deleteRange :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/delete-selection.md b/docs/api/commands/delete-selection.md index e6f21f62..cd63ad52 100644 --- a/docs/api/commands/delete-selection.md +++ b/docs/api/commands/delete-selection.md @@ -1,5 +1,5 @@ # deleteSelection :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/enter.md b/docs/api/commands/enter.md index c8106223..dc4f3d42 100644 --- a/docs/api/commands/enter.md +++ b/docs/api/commands/enter.md @@ -1,5 +1,5 @@ # enter :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/exit-code.md b/docs/api/commands/exit-code.md index 26daec4e..5c2cf7e0 100644 --- a/docs/api/commands/exit-code.md +++ b/docs/api/commands/exit-code.md @@ -1,5 +1,5 @@ # exitCode :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/insert-content-at.md b/docs/api/commands/insert-content-at.md index bf2085c1..73bc4930 100644 --- a/docs/api/commands/insert-content-at.md +++ b/docs/api/commands/insert-content-at.md @@ -1,5 +1,5 @@ # insertContentAt :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/join-backward.md b/docs/api/commands/join-backward.md index 27c7374d..2a4a2a90 100644 --- a/docs/api/commands/join-backward.md +++ b/docs/api/commands/join-backward.md @@ -1,5 +1,5 @@ # joinBackward :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/join-forward.md b/docs/api/commands/join-forward.md index 17814a0f..7913b1f4 100644 --- a/docs/api/commands/join-forward.md +++ b/docs/api/commands/join-forward.md @@ -1,7 +1,7 @@ # joinForward :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: https://prosemirror.net/docs/ref/#commands.joinForward diff --git a/docs/api/commands/keyboard-shortcut.md b/docs/api/commands/keyboard-shortcut.md index ad3904ed..614a5400 100644 --- a/docs/api/commands/keyboard-shortcut.md +++ b/docs/api/commands/keyboard-shortcut.md @@ -1,5 +1,5 @@ # keyboardShortcut :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/lift-empty-block.md b/docs/api/commands/lift-empty-block.md index 7529c5e8..8badb39a 100644 --- a/docs/api/commands/lift-empty-block.md +++ b/docs/api/commands/lift-empty-block.md @@ -1,5 +1,5 @@ # liftEmptyBlock :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/lift-list-item.md b/docs/api/commands/lift-list-item.md index 2a745abd..cce9b551 100644 --- a/docs/api/commands/lift-list-item.md +++ b/docs/api/commands/lift-list-item.md @@ -1,5 +1,5 @@ # liftListItem :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/lift.md b/docs/api/commands/lift.md index be186c95..cd7d0512 100644 --- a/docs/api/commands/lift.md +++ b/docs/api/commands/lift.md @@ -1,5 +1,5 @@ # lift :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/newline-in-code.md b/docs/api/commands/newline-in-code.md index 4233e969..9fb035b1 100644 --- a/docs/api/commands/newline-in-code.md +++ b/docs/api/commands/newline-in-code.md @@ -1,5 +1,5 @@ # newlineInCode :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/reset-attributes.md b/docs/api/commands/reset-attributes.md index 9239cd24..18613310 100644 --- a/docs/api/commands/reset-attributes.md +++ b/docs/api/commands/reset-attributes.md @@ -1,5 +1,5 @@ # resetAttributes :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/scroll-into-view.md b/docs/api/commands/scroll-into-view.md index 8aef1734..78fe78fd 100644 --- a/docs/api/commands/scroll-into-view.md +++ b/docs/api/commands/scroll-into-view.md @@ -1,5 +1,5 @@ # scrollIntoView :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/select-node-backward.md b/docs/api/commands/select-node-backward.md index 54d227e1..51fda13d 100644 --- a/docs/api/commands/select-node-backward.md +++ b/docs/api/commands/select-node-backward.md @@ -1,5 +1,5 @@ # selectNodeBackward :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/select-node-forward.md b/docs/api/commands/select-node-forward.md index 3ea76caf..98f2ca6b 100644 --- a/docs/api/commands/select-node-forward.md +++ b/docs/api/commands/select-node-forward.md @@ -1,5 +1,5 @@ # selectNodeForward :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/select-parent-node.md b/docs/api/commands/select-parent-node.md index 6d119b32..97248027 100644 --- a/docs/api/commands/select-parent-node.md +++ b/docs/api/commands/select-parent-node.md @@ -1,5 +1,5 @@ # selectParentNode :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/set-mark.md b/docs/api/commands/set-mark.md index 743567d2..0421f318 100644 --- a/docs/api/commands/set-mark.md +++ b/docs/api/commands/set-mark.md @@ -1,5 +1,5 @@ # setMark :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/set-node-selection.md b/docs/api/commands/set-node-selection.md index e0102a98..7d6dbca9 100644 --- a/docs/api/commands/set-node-selection.md +++ b/docs/api/commands/set-node-selection.md @@ -1,5 +1,5 @@ # setNodeSelection :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/set-node.md b/docs/api/commands/set-node.md index d480c44b..30a415b5 100644 --- a/docs/api/commands/set-node.md +++ b/docs/api/commands/set-node.md @@ -1,5 +1,5 @@ # setNode :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/sink-list-item.md b/docs/api/commands/sink-list-item.md index e09bae63..842a3bc5 100644 --- a/docs/api/commands/sink-list-item.md +++ b/docs/api/commands/sink-list-item.md @@ -1,5 +1,5 @@ # sinkListItem :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/split-block.md b/docs/api/commands/split-block.md index c2e919d6..7e4f7b6c 100644 --- a/docs/api/commands/split-block.md +++ b/docs/api/commands/split-block.md @@ -1,5 +1,5 @@ # splitBlock :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/split-list-item.md b/docs/api/commands/split-list-item.md index 409b4bd7..4ce444df 100644 --- a/docs/api/commands/split-list-item.md +++ b/docs/api/commands/split-list-item.md @@ -1,5 +1,5 @@ # splitListItem :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/toggle-list.md b/docs/api/commands/toggle-list.md index d7f1d461..78e5ecd6 100644 --- a/docs/api/commands/toggle-list.md +++ b/docs/api/commands/toggle-list.md @@ -1,5 +1,5 @@ # toggleList :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/toggle-mark.md b/docs/api/commands/toggle-mark.md index ca3758d8..0b6ee229 100644 --- a/docs/api/commands/toggle-mark.md +++ b/docs/api/commands/toggle-mark.md @@ -1,5 +1,5 @@ # toggleMark :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/toggle-node.md b/docs/api/commands/toggle-node.md index 61801cc6..210cfb78 100644 --- a/docs/api/commands/toggle-node.md +++ b/docs/api/commands/toggle-node.md @@ -1,5 +1,5 @@ # toggleNode :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/toggle-wrap.md b/docs/api/commands/toggle-wrap.md index 693c249b..aada62c1 100644 --- a/docs/api/commands/toggle-wrap.md +++ b/docs/api/commands/toggle-wrap.md @@ -1,5 +1,5 @@ # toggleWrap :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/undo-input-rule.md b/docs/api/commands/undo-input-rule.md index 9932ab83..693c9ebe 100644 --- a/docs/api/commands/undo-input-rule.md +++ b/docs/api/commands/undo-input-rule.md @@ -1,5 +1,5 @@ # undoInputRule :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/unset-all-marks.md b/docs/api/commands/unset-all-marks.md index 08e37be3..5c713290 100644 --- a/docs/api/commands/unset-all-marks.md +++ b/docs/api/commands/unset-all-marks.md @@ -1,5 +1,5 @@ # unsetAllMarks :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/unset-mark.md b/docs/api/commands/unset-mark.md index 375eebf5..ab527be4 100644 --- a/docs/api/commands/unset-mark.md +++ b/docs/api/commands/unset-mark.md @@ -1,5 +1,5 @@ # unsetMark :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/commands/wrap-in-list.md b/docs/api/commands/wrap-in-list.md index 409fb2ef..ea6a1866 100644 --- a/docs/api/commands/wrap-in-list.md +++ b/docs/api/commands/wrap-in-list.md @@ -1,5 +1,5 @@ # wrapInList :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/api/editor.md b/docs/api/editor.md index efa85d2f..f52282bb 100644 --- a/docs/api/editor.md +++ b/docs/api/editor.md @@ -5,7 +5,7 @@ tableOfContents: true # Editor ## Introduction -This class is a central building block of tiptap. It does most of the heavy lifting of creating a working [ProseMirror](https://ProseMirror.net/) editor such as creating the [`EditorView`](https://ProseMirror.net/docs/ref/#view.EditorView), setting the initial [`EditorState`](https://ProseMirror.net/docs/ref/#state.Editor_State) and so on. +This class is a central building block of Tiptap. It does most of the heavy lifting of creating a working [ProseMirror](https://ProseMirror.net/) editor such as creating the [`EditorView`](https://ProseMirror.net/docs/ref/#view.EditorView), setting the initial [`EditorState`](https://ProseMirror.net/docs/ref/#state.Editor_State) and so on. ## Methods The editor instance will provide a bunch of public methods. Methods are regular functions and can return anything. They’ll help you to work with the editor. @@ -151,7 +151,7 @@ editor.isEmpty ## Settings ### element -The `element` specifies the HTML element the editor will be binded too. The following code will integrate tiptap with an element with the `.element` class: +The `element` specifies the HTML element the editor will be binded too. The following code will integrate Tiptap with an element with the `.element` class: ```js import { Editor } from '@tiptap/core' @@ -259,7 +259,7 @@ new Editor({ ``` ### enableInputRules -By default, tiptap enables all [input rules](/guide/custom-extensions/#input-rules). With `enableInputRules` you can disable that. +By default, Tiptap enables all [input rules](/guide/custom-extensions/#input-rules). With `enableInputRules` you can disable that. ```js import { Editor } from '@tiptap/core' @@ -275,7 +275,7 @@ new Editor({ ``` ### enablePasteRules -By default, tiptap enables all [paste rules](/guide/custom-extensions/#paste-rules). With `enablePasteRules` you can disable that. +By default, Tiptap enables all [paste rules](/guide/custom-extensions/#paste-rules). With `enablePasteRules` you can disable that. ```js import { Editor } from '@tiptap/core' @@ -291,7 +291,7 @@ new Editor({ ``` ### injectCSS -By default, tiptap injects [a little bit of CSS](https://github.com/ueberdosis/tiptap/tree/main/packages/core/src/style.ts). With `injectCSS` you can disable that. +By default, Tiptap injects [a little bit of CSS](https://github.com/ueberdosis/tiptap/tree/main/packages/core/src/style.ts). With `injectCSS` you can disable that. ```js import { Editor } from '@tiptap/core' diff --git a/docs/api/extensions.md b/docs/api/extensions.md index 8220678f..501fb2a8 100644 --- a/docs/api/extensions.md +++ b/docs/api/extensions.md @@ -5,7 +5,7 @@ tableOfContents: true # Extensions ## Introduction -Extensions add new capabilities to tiptap and you’ll read the word extension here very often. Actually, there are literal Extensions. Those can’t add to the schema, but can add functionality or change the behaviour of the editor. +Extensions add new capabilities to Tiptap and you’ll read the word extension here very often. Actually, there are literal Extensions. Those can’t add to the schema, but can add functionality or change the behaviour of the editor. There are also some extensions with more capabilities. We call them [nodes](/api/nodes) and [marks](/api/marks) which can render content in the editor. @@ -29,14 +29,14 @@ There are also some extensions with more capabilities. We call them [nodes](/api You don’t have to use it, but we prepared a `@tiptap/starter-kit` which includes the most common extensions. Read more about [`StarterKit`](/guide/configuration#default-extensions). ## How extensions work -Although tiptap tries to hide most of the complexity of ProseMirror, it’s built on top of its APIs and we recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/) for advanced usage. You’ll have a better understanding of how everything works under the hood and get more familiar with many terms and jargon used by tiptap. +Although Tiptap tries to hide most of the complexity of ProseMirror, it’s built on top of its APIs and we recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/) for advanced usage. You’ll have a better understanding of how everything works under the hood and get more familiar with many terms and jargon used by Tiptap. Existing [nodes](/api/nodes), [marks](/api/marks) and [extensions](/api/extensions) can give you a good impression on how to approach your own extensions. To make it easier to switch between the documentation and the source code, we linked to the file on GitHub from every single extension documentation page. We recommend to start with customizing existing extensions first, and create your own extensions with the gained knowledge later. That’s why all the below examples extend existing extensions, but all examples will work on newly created extensions aswell. ## Create a new extension -You’re free to create your own extensions for tiptap. Here is the boilerplate code that’s need to create and register your own extension: +You’re free to create your own extensions for Tiptap. Here is the boilerplate code that’s need to create and register your own extension: ```js import { Extension } from '@tiptap/core' diff --git a/docs/api/extensions/dropcursor.md b/docs/api/extensions/dropcursor.md index 1273e25c..70fa0df4 100644 --- a/docs/api/extensions/dropcursor.md +++ b/docs/api/extensions/dropcursor.md @@ -9,7 +9,7 @@ icon: drag-drop-line This extension loads the [ProseMirror Dropcursor plugin](https://github.com/ProseMirror/prosemirror-dropcursor) by Marijn Haverbeke, which shows a cursor at the drop position when something is dragged into the editor. -Note that tiptap is headless, but the dropcursor needs CSS for its appearance. There are settings for the color and width, and you’re free to add a custom CSS class. +Note that Tiptap is headless, but the dropcursor needs CSS for its appearance. There are settings for the color and width, and you’re free to add a custom CSS class. ## Installation ```bash diff --git a/docs/api/extensions/gapcursor.md b/docs/api/extensions/gapcursor.md index 8b0e1d78..59551f51 100644 --- a/docs/api/extensions/gapcursor.md +++ b/docs/api/extensions/gapcursor.md @@ -9,7 +9,7 @@ icon: space This extension loads the [ProseMirror Gapcursor plugin](https://github.com/ProseMirror/prosemirror-gapcursor) by Marijn Haverbeke, which adds a gap for the cursor in places that don’t allow regular selection. For example, after a table at the end of a document. -Note that tiptap is headless, but the gapcursor needs CSS for its appearance. The [default CSS](https://github.com/ueberdosis/tiptap/tree/main/packages/core/src/style.ts) is loaded through the Editor class. +Note that Tiptap is headless, but the gapcursor needs CSS for its appearance. The [default CSS](https://github.com/ueberdosis/tiptap/tree/main/packages/core/src/style.ts) is loaded through the Editor class. ## Installation ```bash diff --git a/docs/api/extensions/starter-kit.md b/docs/api/extensions/starter-kit.md index e55500c8..41d61706 100644 --- a/docs/api/extensions/starter-kit.md +++ b/docs/api/extensions/starter-kit.md @@ -7,7 +7,7 @@ icon: stack-line [![Version](https://img.shields.io/npm/v/@tiptap/starter-kit.svg?label=version)](https://www.npmjs.com/package/@tiptap/starter-kit) [![Downloads](https://img.shields.io/npm/dm/@tiptap/starter-kit.svg)](https://npmcharts.com/compare/@tiptap/starter-kit?minimal=true) -The `StarterKit` is a collection of the most popular tiptap extensions. If you’re just getting started, this extension is for you. +The `StarterKit` is a collection of the most popular Tiptap extensions. If you’re just getting started, this extension is for you. ## Installation ```bash diff --git a/docs/api/introduction.md b/docs/api/introduction.md index 26157203..0a90cd7e 100644 --- a/docs/api/introduction.md +++ b/docs/api/introduction.md @@ -1,5 +1,5 @@ # Introduction -tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net). Although tiptap tries to hide most of the complexity of ProseMirror, it’s built on top of its APIs and we recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/) for advanced usage. +tiptap is a friendly wrapper around [ProseMirror](https://ProseMirror.net). Although Tiptap tries to hide most of the complexity of ProseMirror, it’s built on top of its APIs and we recommend you to read through the [ProseMirror Guide](https://ProseMirror.net/docs/guide/) for advanced usage. ### Structure ProseMirror works with a strict [Schema](/api/schema), which defines the allowed structure of a document. A document is a tree of headings, paragraphs and others elements, so called nodes. Marks can be attached to a node, e. g. to emphasize part of it. [Commands](/api/commands) change that document programmatically. diff --git a/docs/api/nodes.md b/docs/api/nodes.md index 694e86d4..0e5f29a2 100644 --- a/docs/api/nodes.md +++ b/docs/api/nodes.md @@ -32,7 +32,7 @@ If you think of the document as a tree, then nodes are just a type of content in | [Text](/api/nodes/text) | Included | [GitHub](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-text/) | ## Create a new node -You’re free to create your own nodes for tiptap. Here is the boilerplate code that’s need to create and register your own node: +You’re free to create your own nodes for Tiptap. Here is the boilerplate code that’s need to create and register your own node: ```js import { Node } from '@tiptap/core' diff --git a/docs/api/nodes/document.md b/docs/api/nodes/document.md index 3c92a985..49d2baa7 100644 --- a/docs/api/nodes/document.md +++ b/docs/api/nodes/document.md @@ -7,7 +7,7 @@ icon: file-line [![Version](https://img.shields.io/npm/v/@tiptap/extension-document.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-document) [![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-document.svg)](https://npmcharts.com/compare/@tiptap/extension-document?minimal=true) -**The `Document` extension is required**, no matter what you build with tiptap. It’s a so called “topNode”, a node that’s the home to all other nodes. Think of it like the `` tag for your document. +**The `Document` extension is required**, no matter what you build with Tiptap. It’s a so called “topNode”, a node that’s the home to all other nodes. Think of it like the `` tag for your document. The node is very tiny though. It defines a name of the node (`doc`), is configured to be a top node (`topNode: true`) and that it can contain multiple other nodes (`block+`). That’s all. But have a look yourself: diff --git a/docs/api/nodes/emoji.md b/docs/api/nodes/emoji.md index 7511019f..2c1c4f02 100644 --- a/docs/api/nodes/emoji.md +++ b/docs/api/nodes/emoji.md @@ -11,7 +11,7 @@ There is no extension or example yet, but it’s definitely on our list to build If you want to give it a shot yourself, you could start altering the [`Mention`](/api/nodes/mention) node. This uses the [`Suggestion`](/api/utilities/suggestion) utility, which should help with an autocomplete and such things. :::pro Fund the development ♥ -We need your support to maintain, update, support and develop tiptap. If you’re waiting for this extension, [become a sponsor and fund our work](/sponsor). +We need your support to maintain, update, support and develop Tiptap. If you’re waiting for this extension, [become a sponsor and fund our work](/sponsor). ::: ## Bring your own emoji picker diff --git a/docs/api/nodes/hashtag.md b/docs/api/nodes/hashtag.md index 981e43b9..9aefbfe7 100644 --- a/docs/api/nodes/hashtag.md +++ b/docs/api/nodes/hashtag.md @@ -6,7 +6,7 @@ icon: hashtag # Hashtag :::pro Fund the development ♥ -We need your support to maintain, update, support and develop tiptap. If you’re waiting for this extension, [become a sponsor and fund our work](/sponsor). +We need your support to maintain, update, support and develop Tiptap. If you’re waiting for this extension, [become a sponsor and fund our work](/sponsor). ::: TODO diff --git a/docs/api/nodes/image.md b/docs/api/nodes/image.md index 730cca75..6c43bf2d 100644 --- a/docs/api/nodes/image.md +++ b/docs/api/nodes/image.md @@ -38,7 +38,7 @@ Image.configure({ ### inline Renders the image node inline, for example in a paragraph tag: `

`. By default images are on the same level as paragraphs. -It totally depends on what kind of editing experience you’d like to have, but can be useful if you (for example) migrate from Quill to tiptap. +It totally depends on what kind of editing experience you’d like to have, but can be useful if you (for example) migrate from Quill to Tiptap. Default: `false` diff --git a/docs/api/schema.md b/docs/api/schema.md index 815ee622..a08ec9a2 100644 --- a/docs/api/schema.md +++ b/docs/api/schema.md @@ -5,11 +5,11 @@ tableOfContents: true # Schema ## Introduction -Unlike many other editors, tiptap is based on a [schema](https://prosemirror.net/docs/guide/#schema) that defines how your content is structured. That enables you to define the kind of nodes that may occur in the document, its attributes and the way they can be nested. +Unlike many other editors, Tiptap is based on a [schema](https://prosemirror.net/docs/guide/#schema) that defines how your content is structured. That enables you to define the kind of nodes that may occur in the document, its attributes and the way they can be nested. This schema is *very* strict. You can’t use any HTML element or attribute that is not defined in your schema. -Let me give you one example: If you paste something like `This is important` into tiptap, but don’t have any extension that handles `strong` tags, you’ll only see `This is important` – without the strong tags. +Let me give you one example: If you paste something like `This is important` into Tiptap, but don’t have any extension that handles `strong` tags, you’ll only see `This is important` – without the strong tags. ## How a schema looks like When you’ll work with the provided extensions only, you don’t have to care that much about the schema. If you’re building your own extensions, it’s probably helpful to understand how the schema works. Let’s look at the most simple schema for a typical ProseMirror editor: @@ -36,10 +36,10 @@ When you’ll work with the provided extensions only, you don’t have to care t We register three nodes here. `doc`, `paragraph` and `text`. `doc` is the root node which allows one or more block nodes as children (`content: 'block+'`). Since `paragraph` is in the group of block nodes (`group: 'block'`) our document can only contain paragraphs. Our paragraphs allow zero or more inline nodes as children (`content: 'inline*'`) so there can only be `text` in it. `parseDOM` defines how a node can be parsed from pasted HTML. `toDOM` defines how it will be rendered in the DOM. -In tiptap every node, mark and extension is living in its own file. This allows us to split the logic. Under the hood the whole schema will be merged together: +In Tiptap every node, mark and extension is living in its own file. This allows us to split the logic. Under the hood the whole schema will be merged together: ```js -// the tiptap schema API +// the Tiptap schema API import { Node } from '@tiptap/core' const Document = Node.create({ @@ -294,7 +294,7 @@ Mark.create({ ``` ## Get the underlying ProseMirror schema -There are a few use cases where you need to work with the underlying schema. You’ll need that if you’re using the tiptap collaborative text editing features or if you want to manually render your content as HTML. +There are a few use cases where you need to work with the underlying schema. You’ll need that if you’re using the Tiptap collaborative text editing features or if you want to manually render your content as HTML. ### Option 1: With an Editor If you need this on the client side and need an editor instance anyway, it’s available through the editor: diff --git a/docs/changelog.md b/docs/changelog.md index 29f90eb0..fe677e03 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,5 +5,5 @@ tableOfContents: true # Changelog :::warning -Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) +Oops, we didn’t find time to fill this page. Writing documentation needs attention to detail, a great understanding of the project and time to write. Though Tiptap is used by thousands of developers all around the world, it’s still a side project for us. Let’s change that and make open source our full-time job! [Become a sponsor!](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/examples/collaborative-editing.md b/docs/examples/collaborative-editing.md index 263764b2..306f24d9 100644 --- a/docs/examples/collaborative-editing.md +++ b/docs/examples/collaborative-editing.md @@ -9,7 +9,7 @@ Using the collaborative editing commercially? [Become a sponsor](/sponsor) to fu ::: ## Introduction -This example shows how you can use tiptap to let multiple users collaborate in the same document in real-time. +This example shows how you can use Tiptap to let multiple users collaborate in the same document in real-time. It connects all clients to a WebSocket server and merges changes to the document with the power of [Y.js](https://github.com/yjs/yjs). If you want to learn more about collaborative text editing, check out [our guide on collaborative editing](/guide/collaborative-editing). diff --git a/docs/examples/drawing.md b/docs/examples/drawing.md index bc7cfb72..c2051f82 100644 --- a/docs/examples/drawing.md +++ b/docs/examples/drawing.md @@ -1,4 +1,4 @@ # Drawing -Did you ever wanted to draw in a text editor? Me neither. Anyway, here is an example how that could work with tiptap. If you want to build something like that, [learn more about node views](/guide/node-views). +Did you ever wanted to draw in a text editor? Me neither. Anyway, here is an example how that could work with Tiptap. If you want to build something like that, [learn more about node views](/guide/node-views). https://embed.tiptap.dev/preview/Examples/Drawing diff --git a/docs/examples/images.md b/docs/examples/images.md index d656a703..c290dcda 100644 --- a/docs/examples/images.md +++ b/docs/examples/images.md @@ -3,7 +3,7 @@ :::pro What about … We’d love to build more features related to images: Resizeable images, images with a caption, floating images … But that takes time. -Though thousands of developers use tiptap every day, it’s still not our full-time job. We’d like to change that. Are you able to help us reach our goal? +Though thousands of developers use Tiptap every day, it’s still not our full-time job. We’d like to change that. Are you able to help us reach our goal? [Become a sponsor on GitHub →](https://github.com/sponsors/ueberdosis) ::: diff --git a/docs/experiments/linter.md b/docs/experiments/linter.md index a6a5700e..40dfddba 100644 --- a/docs/experiments/linter.md +++ b/docs/experiments/linter.md @@ -5,6 +5,6 @@ Linter can be used to check the content as per your wish and highlight it to the user. Linter extension can have multiple plugins for each task you want to achieve. ## Issues -* There is no decoration API in tiptap, that’s why this is a lot of ProseMirror work. Before we’ll publish that example, we’d need to find a few ways to make it more tiptap-like. For example, it would be great to use Vue/React components for the widget. +* There is no decoration API in Tiptap, that’s why this is a lot of ProseMirror work. Before we’ll publish that example, we’d need to find a few ways to make it more Tiptap-like. For example, it would be great to use Vue/React components for the widget. https://embed.tiptap.dev/preview/Experiments/Linter diff --git a/docs/experiments/multiple-editors.md b/docs/experiments/multiple-editors.md index a0be0a19..258428a0 100644 --- a/docs/experiments/multiple-editors.md +++ b/docs/experiments/multiple-editors.md @@ -1,5 +1,5 @@ # Multiple editors -The following example has three different instances of tiptap. The first is configured to have a single paragraph of text, the second to have a task list and the third to have text. All of them are stored in a single Y.js document, which can be synced in real-time with other users. +The following example has three different instances of Tiptap. The first is configured to have a single paragraph of text, the second to have a task list and the third to have text. All of them are stored in a single Y.js document, which can be synced in real-time with other users. https://embed.tiptap.dev/preview/Experiments/MultipleEditors diff --git a/docs/guide/accessibility.md b/docs/guide/accessibility.md index ac556054..cebc87f8 100644 --- a/docs/guide/accessibility.md +++ b/docs/guide/accessibility.md @@ -5,11 +5,11 @@ tableOfContents: true # Accessibility :::pro Fund the development ♥ -We need your support to maintain, update, support and develop tiptap. If you’re waiting for progress here, [become a sponsor and fund our work](/sponsor). +We need your support to maintain, update, support and develop Tiptap. If you’re waiting for progress here, [become a sponsor and fund our work](/sponsor). ::: ## Introduction -We strive to make tiptap accessible to everyone, but to be honest, there’s not much work done now. From our current understanding, that’s what needs to be done: +We strive to make Tiptap accessible to everyone, but to be honest, there’s not much work done now. From our current understanding, that’s what needs to be done: ## Interface An interface needs to have well-defined contrasts, big enough click areas, semantic markup, must be keyboard accessible and well documented. Currently, we don’t even provide an interface, so for now that’s totally up to you. @@ -17,7 +17,7 @@ An interface needs to have well-defined contrasts, big enough click areas, seman But no worries, we’ll provide an interface soon and take accessibility into account early on. ## Output -The editor needs to produce semantic markup, must be keyboard accessible and well documented. The tiptap content is well structured so that’s a good foundation already. That said, we can add support and encourage the usage of additional attributes, for example the Alt-attribute for images. +The editor needs to produce semantic markup, must be keyboard accessible and well documented. The Tiptap content is well structured so that’s a good foundation already. That said, we can add support and encourage the usage of additional attributes, for example the Alt-attribute for images. ### Writing assistance (optional) An optional writing assitance could help people writing content semanticly correct, for example pointing out an incorrect usage of heading levels. With that kind of assistance provided by the core developers, we could help to improve the content of a lot of applications. diff --git a/docs/guide/collaborative-editing.md b/docs/guide/collaborative-editing.md index 1dcd6dea..bedddb3f 100644 --- a/docs/guide/collaborative-editing.md +++ b/docs/guide/collaborative-editing.md @@ -5,10 +5,10 @@ tableOfContents: true # Collaborative editing ## Introduction -Real-time collaboration, syncing between different devices and working offline used to be hard. We provide everything you need to keep everything in sync, conflict-free with the power of [Y.js](https://github.com/yjs/yjs). The following guide explains all things to take into account when you consider to make tiptap collaborative. Don’t worry, a production-grade setup doesn’t require much code. +Real-time collaboration, syncing between different devices and working offline used to be hard. We provide everything you need to keep everything in sync, conflict-free with the power of [Y.js](https://github.com/yjs/yjs). The following guide explains all things to take into account when you consider to make Tiptap collaborative. Don’t worry, a production-grade setup doesn’t require much code. ## Configure the editor -The underyling schema tiptap uses is an excellent foundation to sync documents. With the [`Collaboration`](/api/extensions/collaboration) you can tell tiptap to track changes to the document with [Y.js](https://github.com/yjs/yjs). +The underyling schema Tiptap uses is an excellent foundation to sync documents. With the [`Collaboration`](/api/extensions/collaboration) you can tell Tiptap to track changes to the document with [Y.js](https://github.com/yjs/yjs). Y.js is a conflict-free replicated data types implementation, or in other words: It’s reaaally good in merging changes. And to achieve that, changes don’t have to come in order. It’s totally fine to change a document while being offline and merge it with other changes when the device is online again. @@ -27,7 +27,7 @@ npm install @tiptap/extension-collaboration yjs y-webrtc yarn add @tiptap/extension-collaboration yjs y-webrtc ``` -Now, create a new Y document, and register it with tiptap: +Now, create a new Y document, and register it with Tiptap: ```js import { Editor } from '@tiptap/core' @@ -43,7 +43,7 @@ const provider = new WebrtcProvider('example-document', ydoc) const editor = new Editor({ extensions: [ // … - // Register the document with tiptap + // Register the document with Tiptap Collaboration.configure({ document: ydoc, }), @@ -51,7 +51,7 @@ const editor = new Editor({ }) ``` -This should be enough to create a collaborative instance of tiptap. Crazy, isn’t it? Try it out, and open the editor in two different browsers. Changes should be synced between different windows. +This should be enough to create a collaborative instance of Tiptap. Crazy, isn’t it? Try it out, and open the editor in two different browsers. Changes should be synced between different windows. So how does this magic work? All clients need to connect with eachother, that’s the job of a *provider*. The [WebRTC provider](https://github.com/yjs/y-webrtc) is the easiest way to get started with, as it requires a public server to connect clients directly with each other, but not to sync the actual changes. This has two downsides, though. @@ -71,7 +71,7 @@ npm install @tiptap/extension-collaboration yjs y-websocket yarn add @tiptap/extension-collaboration yjs y-websocket ``` -And then register the WebSocket provider with tiptap: +And then register the WebSocket provider with Tiptap: ```js import { Editor } from '@tiptap/core' @@ -87,7 +87,7 @@ const provider = new WebsocketProvider('ws://127.0.0.1:1234', 'example-document' const editor = new Editor({ extensions: [ // … - // Register the document with tiptap + // Register the document with Tiptap Collaboration.configure({ document: ydoc, }), @@ -135,7 +135,7 @@ node ./index.js Try opening http://127.0.0.1:1234 in your browser. You should see a plain text `OK` if everything works fine. -Go back to your tiptap editor and hit reload, it should now connect to the WebSocket server and changes should sync with all other clients. Amazing, isn’t it? +Go back to your Tiptap editor and hit reload, it should now connect to the WebSocket server and changes should sync with all other clients. Amazing, isn’t it? ### Multiple network providers You can even combine multiple providers. That’s not needed, but could keep clients connected, even if one connection - for example the WebSocket server - goes down for a while. Here is an example: @@ -239,7 +239,7 @@ In the backend, you can split the string to know the user is typing on a page wi And if you’d like to sync multiple fields with one Y.js document, just pass different fragment names to the collaboration extension: ```js -// a tiptap instance for the field +// a Tiptap instance for the field Collaboration.configure({ document: ydoc, field: 'title', @@ -354,11 +354,11 @@ hocuspocus.listen() ### Schema updates tiptap is very strict with the [schema](/api/schema), that means, if you add something that’s not allowed according to the configured schema it’ll be thrown away. That can lead to a strange behaviour when multiple clients with different schemas share changes to a document. -Let’s say you added an editor to your app and the first people use it already. They have all a loaded instance of tiptap with all default extensions, and therefor a schema that only allows those. But you want to add task lists in the next update, so you add the extension and deploy again. +Let’s say you added an editor to your app and the first people use it already. They have all a loaded instance of Tiptap with all default extensions, and therefor a schema that only allows those. But you want to add task lists in the next update, so you add the extension and deploy again. A new user opens your app and has the updated schema (with task lists), while all others still have the old schema (without task lists). The new user checks out the newly added tasks lists and adds it to a document to show that feature to other users in that document. But then, it magically disappears right after she added it. What happened? -When one user adds a new node (or mark), that change will be synced to all other connected clients. The other connected clients apply those changes to the editor, and tiptap, strict as it is, removes the newly added node, because it’s not allowed according to their (old) schema. Those changes will be synced to other connected clients and oops, it’s removed everywhere. To avoid this you have a few options: +When one user adds a new node (or mark), that change will be synced to all other connected clients. The other connected clients apply those changes to the editor, and Tiptap, strict as it is, removes the newly added node, because it’s not allowed according to their (old) schema. Those changes will be synced to other connected clients and oops, it’s removed everywhere. To avoid this you have a few options: 1. Never change the schema (not cool). 2. Force clients to update when you deploy a new schema (tough). diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index 58a23163..fafe9160 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -5,7 +5,7 @@ tableOfContents: true # Configuration ## Introduction -For most cases it’s enough to say where tiptap should be rendered (`element`), what functionalities you want to enable (`extensions`) and what the initial document should be (`content`). +For most cases it’s enough to say where Tiptap should be rendered (`element`), what functionalities you want to enable (`extensions`) and what the initial document should be (`content`). A few more things can be configured though. Let’s look at a fully configured editor example. @@ -34,7 +34,7 @@ new Editor({ This will do the following: -1. bind tiptap to `.element`, +1. bind Tiptap to `.element`, 2. load the `Document`, `Paragraph` and `Text` extensions, 3. set the initial content, 4. place the cursor in the editor after initialization, @@ -63,7 +63,7 @@ new Editor({ ``` ### Configure extensions -Most extensions can be configured. Add a `.configure()` and pass an object to it. +Most extensions can be configured. Add a `.configure()` and pass an object to it. The following example will disable the default heading levels 4, 5 and 6 and just allow 1, 2 and 3: diff --git a/docs/guide/custom-extensions.md b/docs/guide/custom-extensions.md index 506c8010..e5e0a8fb 100644 --- a/docs/guide/custom-extensions.md +++ b/docs/guide/custom-extensions.md @@ -5,7 +5,7 @@ tableOfContents: true # Custom extensions ## Introduction -One of the strengths of tiptap is its extendability. You don’t depend on the provided extensions, it is intended to extend the editor to your liking. +One of the strengths of Tiptap is its extendability. You don’t depend on the provided extensions, it is intended to extend the editor to your liking. With custom extensions you can add new content types and new functionalities, on top of what already exists or from scratch. Let’s start with a few common examples of how you can extend existing nodes, marks and extensions. @@ -65,7 +65,7 @@ The order in which extensions are loaded influences two things: The [`Link`](/api/marks/link) mark for example has a higher priority, which means it will be rendered as `Example` instead of `Example`. ### Settings -All settings can be configured through the extension anyway, but if you want to change the default settings, for example to provide a library on top of tiptap for other developers, you can do it like that: +All settings can be configured through the extension anyway, but if you want to change the default settings, for example to provide a library on top of Tiptap for other developers, you can do it like that: ```js import Heading from '@tiptap/extension-heading' @@ -124,7 +124,7 @@ const CustomParagraph = Paragraph.extend({ //

Example Text

``` -That is already enough to tell tiptap about the new attribute, and set `'pink'` as the default value. All attributes will be rendered as a HTML attribute by default, and parsed from the content when initiated. +That is already enough to tell Tiptap about the new attribute, and set `'pink'` as the default value. All attributes will be rendered as a HTML attribute by default, and parsed from the content when initiated. Let’s stick with the color example and assume you want to add an inline style to actually color the text. With the `renderHTML` function you can return HTML attributes which will be rendered in the output. @@ -486,10 +486,10 @@ this.parent ``` ### ProseMirror Plugins (Advanced) -After all, tiptap is built on ProseMirror and ProseMirror has a pretty powerful plugin API, too. To access that directly, use `addProseMirrorPlugins()`. +After all, Tiptap is built on ProseMirror and ProseMirror has a pretty powerful plugin API, too. To access that directly, use `addProseMirrorPlugins()`. #### Existing plugins -You can wrap existing ProseMirror plugins in tiptap extensions like shown in the example below. +You can wrap existing ProseMirror plugins in Tiptap extensions like shown in the example below. ```js import { history } from 'prosemirror-history' @@ -507,7 +507,7 @@ const History = Extension.create({ #### Access the ProseMirror API To hook into events, for example a click, double click or when content is pasted, you can pass [event handlers](https://prosemirror.net/docs/ref/#view.EditorProps) to `editorProps` on the [editor](/api/editor#editor-props). -Or you can add them to a tiptap extension like shown in the below example. +Or you can add them to a Tiptap extension like shown in the below example. ```js import { Extension } from '@tiptap/core' @@ -596,7 +596,7 @@ const CustomMark = Mark.create({ ``` ### Create an extension -Extensions add new capabilities to tiptap and you’ll read the word extension here very often, even for nodes and marks. But there are literal extensions. Those can’t add to the schema (like marks and nodes do), but can add functionality or change the behaviour of the editor. +Extensions add new capabilities to Tiptap and you’ll read the word extension here very often, even for nodes and marks. But there are literal extensions. Those can’t add to the schema (like marks and nodes do), but can add functionality or change the behaviour of the editor. A good example to learn from is probably [`TextAlign`](/api/extensions/text-align). diff --git a/docs/guide/menus.md b/docs/guide/menus.md index 3f6acf09..35ce9d35 100644 --- a/docs/guide/menus.md +++ b/docs/guide/menus.md @@ -46,7 +46,7 @@ Oh, that’s a long command, right? Actually, it’s a [chain of commands](/api/ editor.chain().focus().toggleBold().run() ``` -1. `editor` should be a tiptap instance, +1. `editor` should be a Tiptap instance, 2. `chain()` is used to tell the editor you want to execute multiple commands, 3. `focus()` sets the focus back to the editor, 4. `toggleBold()` marks the selected text bold, or removes the bold mark from the text selection if it’s already applied and diff --git a/docs/guide/node-views.md b/docs/guide/node-views.md index 0108c043..af5eca21 100644 --- a/docs/guide/node-views.md +++ b/docs/guide/node-views.md @@ -7,7 +7,7 @@ tableOfContents: true ## Introduction Node views are the best thing since sliced bread, at least if you are a fan of customization (and bread). With node views you can add interactive nodes to your editor. That can literally be everything. If you can write it in JavaScript, you can use it in your editor. -Node views are amazing to improve the in-editor experience, but can also be used in a read-only instance of tiptap. They are unrelated to the HTML output by design, so you have full control about the in-editor experience *and* the output. +Node views are amazing to improve the in-editor experience, but can also be used in a read-only instance of Tiptap. They are unrelated to the HTML output by design, so you have full control about the in-editor experience *and* the output. ## Different types of node views Depending on what you would like to build, node views work a little bit different and can have their verify specific capabilities, but also pitfalls. The main question is: How should your custom node look like? @@ -40,7 +40,7 @@ tiptap adds a `contenteditable="false"` to those by default. That’s how you could render mentions, which shouldn’t be editable. Users can add or delete them, but not delete single characters. -Statamic uses those for their Bard editor, which renders complex modules inside tiptap, which can have their own text inputs. +Statamic uses those for their Bard editor, which renders complex modules inside Tiptap, which can have their own text inputs. ### Mixed content You can even mix non-editable and editable text. That’s great to build complex things, and still use marks like bold and italic inside the editable content. @@ -63,7 +63,7 @@ You can even mix non-editable and editable text. That’s great to build complex ``` ## Markup -But what happens if you [access the editor content](/guide/output)? If you’re working with HTML, you’ll need to tell tiptap how your node should be serialized. +But what happens if you [access the editor content](/guide/output)? If you’re working with HTML, you’ll need to tell Tiptap how your node should be serialized. The editor **does not** export the rendered JavaScript node, and for a lot of use cases you wouldn’t want that anyway. @@ -104,7 +104,7 @@ parseHTML() { ``` ### Render JavaScript/Vue/React -But what if you want to render your actual JavaScript/Vue/React code? Consider using tiptap to render your output. Just set the editor to `editable: false` and no one will notice you’re using an editor to render the content. :-) +But what if you want to render your actual JavaScript/Vue/React code? Consider using Tiptap to render your output. Just set the editor to `editable: false` and no one will notice you’re using an editor to render the content. :-)