I’m running tiptap with Vue.js. 🎉
', + content: 'Hello, I’m tiptap running in Vue.js! 👋
', extensions: defaultExtensions(), }) }, diff --git a/docs/src/docPages/api/extensions.md b/docs/src/docPages/api/extensions.md index 5b1d344d..4abce374 100644 --- a/docs/src/docPages/api/extensions.md +++ b/docs/src/docPages/api/extensions.md @@ -1,17 +1,13 @@ # Extensions - Extensions are the way to add functionality to tiptap. By default tiptap comes bare, without any of them, but we have a long list of extensions that are ready to be used with tiptap. ## A minimalist set of extensions - -You’ll need at least three extensions: Document, Paragraph and Text. See [an example of a tiptap version for minimalists](/examples/minimalist). +You’ll need at least three extensions: `Document`, `Paragraph` and `Text`. See [an example of a tiptap version for minimalists](/examples/minimalist). ## Default extensions - You don’t have to use it, but we prepared a `@tiptap/vue-starter-kit` which includes the most common extensions. See [how you can use the `defaultExtensions()`](/examples/basic). ## List of supported extensions - | Title | Default Extension | Source Code | | ------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------- | | [Blockquote](/api/extensions/blockquote) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-blockquote/) | @@ -44,13 +40,9 @@ You don’t have to use it, but we prepared a `@tiptap/vue-starter-kit` which in ## Community extensions - :::warning Work in Progress This section is not ready yet. Meanwhile, [search through GitHub issues](https://github.com/ueberdosis/tiptap/issues) to find code snippets. ::: ## Your custom extensions - Didn’t find what you’re looking for? No worries, [you can build your own extensions](/guide/custom-extensions). - -[@npmjs-tiptap-commands]: https://npmjs.org/package/tiptap-commands diff --git a/docs/src/docPages/overview/installation.md b/docs/src/docPages/overview/installation.md index 6165b073..83b8d838 100644 --- a/docs/src/docPages/overview/installation.md +++ b/docs/src/docPages/overview/installation.md @@ -1,15 +1,7 @@ # Installation - You’re free to use tiptap with the framework of your choice. Depending on what you want to do, there are a few different ways to install tiptap in your project. Choose the way that fits your workflow. -## Overview - -- [Option 1: Vanilla JavaScript](#option-1-vanilla-javascript) -- [Option 2: Vue.js](#option-2-vuejs) -- [Option 3: CodeSandbox](#option-3-codesandbox) - ## Option 1: Vanilla JavaScript - Use tiptap with vanilla JavaScript for a very lightweight and raw experience. If you feel like it, you can even use it to connect tiptap with other frameworks not mentioned here. ```bash @@ -39,7 +31,6 @@ new Editor({ ``` ## Option 2: Vue.js - To use tiptap with Vue.js (and tools that are based on Vue.js) install tiptap together with the Vue.js rendering adapter in your project. We even prepared a Vue.js starter kit, which gives you a good headstart. ```bash @@ -60,10 +51,10 @@ Create a new component and add the following content to get a basic version of t