minor content improvements
This commit is contained in:
@@ -18,7 +18,7 @@ export default {
|
|||||||
|
|
||||||
mounted() {
|
mounted() {
|
||||||
this.editor = new Editor({
|
this.editor = new Editor({
|
||||||
content: '<p>I’m running tiptap with Vue.js. 🎉</p>',
|
content: '<p>Hello, I’m tiptap running in Vue.js! 👋</p>',
|
||||||
extensions: defaultExtensions(),
|
extensions: defaultExtensions(),
|
||||||
})
|
})
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1,17 +1,13 @@
|
|||||||
# Extensions
|
# 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.
|
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
|
## 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
|
## 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).
|
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
|
## List of supported extensions
|
||||||
|
|
||||||
| Title | Default Extension | Source Code |
|
| Title | Default Extension | Source Code |
|
||||||
| ------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------- |
|
||||||
| [Blockquote](/api/extensions/blockquote) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-blockquote/) |
|
| [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
|
|||||||
<!-- | [TodoList](/api/extensions/todo-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-todo-list/) -->
|
<!-- | [TodoList](/api/extensions/todo-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-todo-list/) -->
|
||||||
|
|
||||||
## Community extensions
|
## Community extensions
|
||||||
|
|
||||||
:::warning Work in Progress
|
:::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.
|
This section is not ready yet. Meanwhile, [search through GitHub issues](https://github.com/ueberdosis/tiptap/issues) to find code snippets.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Your custom extensions
|
## Your custom extensions
|
||||||
|
|
||||||
Didn’t find what you’re looking for? No worries, [you can build your own extensions](/guide/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
|
|
||||||
|
|||||||
@@ -1,15 +1,7 @@
|
|||||||
# Installation
|
# 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.
|
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 <!-- omit in toc -->
|
|
||||||
|
|
||||||
- [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
|
## 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.
|
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
|
```bash
|
||||||
@@ -39,7 +31,6 @@ new Editor({
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Option 2: Vue.js
|
## 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.
|
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
|
```bash
|
||||||
@@ -60,10 +51,10 @@ Create a new component and add the following content to get a basic version of t
|
|||||||
|
|
||||||
<demo name="General/Installation" />
|
<demo name="General/Installation" />
|
||||||
|
|
||||||
## Option 3: CodeSandbox
|
<!-- ## Option 3: CodeSandbox
|
||||||
|
|
||||||
CodeSandbox is an online coding environment. It’s great to fiddle around without setting up a local project and to share your code with others.
|
CodeSandbox is an online coding environment. It’s great to fiddle around without setting up a local project and to share your code with others.
|
||||||
|
|
||||||
It’s also amazing for bug reports. Found it a bug? Try to recreate it there and share it with us before you [file an issue on GitHub](https://github.com/ueberdosis/tiptap-next/issues/new). That helps to fix bugs faster.
|
It’s also amazing for bug reports. Found it a bug? Try to recreate it there and share it with us before you [file an issue on GitHub](https://github.com/ueberdosis/tiptap-next/issues/new). That helps to fix bugs faster.
|
||||||
|
|
||||||
* [Vue.js/tiptap on CodeSandbox](https://codesandbox.io/s/vue-issue-template-h0g28)
|
* [Vue.js/tiptap on CodeSandbox](https://codesandbox.io/s/vue-issue-template-h0g28) -->
|
||||||
|
|||||||
Reference in New Issue
Block a user