Example Content
') +``` + diff --git a/docs/src/docPages/api/editor.md b/docs/src/docPages/api/editor.md index 616c66d0..d47c4c9b 100644 --- a/docs/src/docPages/api/editor.md +++ b/docs/src/docPages/api/editor.md @@ -129,7 +129,7 @@ new Editor({ | `null` | Disables autofocus. | ### Enable input rules -By default, tiptap enables all [input rules](/guide/build-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' @@ -143,7 +143,7 @@ new Editor({ ``` ### Enable paste rules -By default, tiptap enables all [paste rules](/guide/build-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' diff --git a/docs/src/docPages/api/nodes.md b/docs/src/docPages/api/nodes.md index 928b5fa2..ae84898b 100644 --- a/docs/src/docPages/api/nodes.md +++ b/docs/src/docPages/api/nodes.md @@ -51,4 +51,4 @@ const editor = new Editor({ ], ``` -Learn [more about custom extensions in our guide](/guide/build-extensions). +Learn [more about custom extensions in our guide](/guide/custom-extensions). diff --git a/docs/src/docPages/api/schema.md b/docs/src/docPages/api/schema.md index 5980c28e..68ac2b52 100644 --- a/docs/src/docPages/api/schema.md +++ b/docs/src/docPages/api/schema.md @@ -7,7 +7,7 @@ Unlike many other editors, tiptap is based on a [schema](https://prosemirror.net 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, don’t have any extension that handles `strong` tags registered, 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: diff --git a/docs/src/docPages/community.md b/docs/src/docPages/community.md new file mode 100644 index 00000000..1812b994 --- /dev/null +++ b/docs/src/docPages/community.md @@ -0,0 +1,4 @@ +# Community +* GitHub https://github.com/ueberdosis/tiptap-next +* Discord https://discord.gg/WtJ49jGshW +* Twitter https://twitter.com/tiptap_editor diff --git a/docs/src/docPages/guide/configuration.md b/docs/src/docPages/guide/configuration.md index 1f099c39..de6e638a 100644 --- a/docs/src/docPages/guide/configuration.md +++ b/docs/src/docPages/guide/configuration.md @@ -1,4 +1,4 @@ -# Configure the editor +# Configuration ## toc diff --git a/docs/src/docPages/guide/build-extensions.md b/docs/src/docPages/guide/custom-extensions.md similarity index 79% rename from docs/src/docPages/guide/build-extensions.md rename to docs/src/docPages/guide/custom-extensions.md index 02a5772a..d4a5f908 100644 --- a/docs/src/docPages/guide/build-extensions.md +++ b/docs/src/docPages/guide/custom-extensions.md @@ -1,9 +1,9 @@ -# Build extensions +# Custom extensions ## toc ## Introduction -You can build your own extensions from scratch with the `Node`, `Mark`, and `Extension` classes. Just pass an object with your configuration and custom code. Read the guide on [extending the functionality](/guide/extend-extensions) to learn more about all the things you can control. +You can build your own extensions from scratch with the `Node`, `Mark`, and `Extension` classes. Just pass an object with your configuration and custom code. Read the [ovewrite & extend](/guide/extend-extensions) guide to learn more about all the things you can control. And if everything is working fine, don’t forget to [share it with the community](https://github.com/ueberdosis/tiptap/issues/819). diff --git a/docs/src/docPages/guide/extend-extensions.md b/docs/src/docPages/guide/extend-extensions.md index 8f350bcc..4f749e0e 100644 --- a/docs/src/docPages/guide/extend-extensions.md +++ b/docs/src/docPages/guide/extend-extensions.md @@ -1,4 +1,4 @@ -# Extend the functionality +# Overwrite & extend ## toc @@ -37,7 +37,7 @@ The same applies to every aspect of an existing extension, except to the name. L ### Name The extension name is used in a whole lot of places and changing it isn’t too easy. If you want to change the name of an existing extension, we would recommended to copy the whole extension and change the name in all occurrences. -The extension name is also part of the JSON. If you [store your content as JSON](/guide/content#option-1-json), you need to change the name there too. +The extension name is also part of the JSON. If you [store your content as JSON](/guide/output#option-1-json), you need to change the name there too. ### 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: diff --git a/docs/src/docPages/guide/menus.md b/docs/src/docPages/guide/menus.md index 16cd8825..40c5df7e 100644 --- a/docs/src/docPages/guide/menus.md +++ b/docs/src/docPages/guide/menus.md @@ -49,7 +49,7 @@ Let’s assume you’ve got the editor running already and you want to add your Oh, that’s a long command, right? Actually, it’s a [chain of commands](/api/commands#chain-commands), so let’s go through this one by one: ```js -editor.chain().toggleBold().focus().run() +editor.chain().focus().toggleBold().run() ``` 1. `editor` should be a tiptap instance, diff --git a/docs/src/docPages/guide/node-views.md b/docs/src/docPages/guide/node-views.md index a31e834c..b799dfc1 100644 --- a/docs/src/docPages/guide/node-views.md +++ b/docs/src/docPages/guide/node-views.md @@ -61,7 +61,7 @@ You can even mix non-editable and editable text. That’s great to build complex **BUT**, that also means the cursor can’t just move from outside of the node view to the inside. Users have to manually place their cursor to edit the content inside the node view. Just so you know. ## Markup -But what happens if you [access the editor content](/guide/content)? 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. diff --git a/docs/src/docPages/guide/node-views/js.md b/docs/src/docPages/guide/node-views/js.md index 962cc803..6b734b93 100644 --- a/docs/src/docPages/guide/node-views/js.md +++ b/docs/src/docPages/guide/node-views/js.md @@ -8,7 +8,7 @@ Using frameworks like Vue or React can feel too complex, if you’re used to wor ## Render a node view with JavaScript Here is what you need to do to render a node view inside your editor: -1. [Create a node extension](/guide/build-extensions) +1. [Create a node extension](/guide/custom-extensions) 2. Register a new node view with `addNodeView()` 3. Write your render function 4. [Configure tiptap to use your new node extension](/guide/configuration) diff --git a/docs/src/docPages/guide/node-views/react.md b/docs/src/docPages/guide/node-views/react.md index ea6ae6d8..b3e6c7ff 100644 --- a/docs/src/docPages/guide/node-views/react.md +++ b/docs/src/docPages/guide/node-views/react.md @@ -8,7 +8,7 @@ Using plain JavaScript can feel complex if you are used to work in React. Good n ## Render a React component Here is what you need to do to render React components inside your editor: -1. [Create a node extension](/guide/build-extensions) +1. [Create a node extension](/guide/custom-extensions) 2. Create a React component 3. Pass that component to the provided `ReactNodeViewRenderer` 4. Register it with `addNodeView()` diff --git a/docs/src/docPages/guide/node-views/vue.md b/docs/src/docPages/guide/node-views/vue.md index 344da071..9d97df26 100644 --- a/docs/src/docPages/guide/node-views/vue.md +++ b/docs/src/docPages/guide/node-views/vue.md @@ -8,7 +8,7 @@ Using plain JavaScript can feel complex if you are used to work in Vue. Good new ## Render a Vue component Here is what you need to do to render Vue components inside your editor: -1. [Create a node extension](/guide/build-extensions) +1. [Create a node extension](/guide/custom-extensions) 2. Create a Vue component 3. Pass that component to the provided `VueNodeViewRenderer` 4. Register it with `addNodeView()` diff --git a/docs/src/docPages/guide/content.md b/docs/src/docPages/guide/output.md similarity index 99% rename from docs/src/docPages/guide/content.md rename to docs/src/docPages/guide/output.md index 4621311f..1d53f1d3 100644 --- a/docs/src/docPages/guide/content.md +++ b/docs/src/docPages/guide/output.md @@ -1,4 +1,4 @@ -# Export content +# Output ## toc diff --git a/docs/src/docPages/guide/styling.md b/docs/src/docPages/guide/styling.md index 7daa6dce..748026d8 100644 --- a/docs/src/docPages/guide/styling.md +++ b/docs/src/docPages/guide/styling.md @@ -1,4 +1,4 @@ -# Custom styling +# Styling ## toc diff --git a/docs/src/docPages/overview/upgrade-guide.md b/docs/src/docPages/overview/upgrade-guide.md index 554fb753..39f557b2 100644 --- a/docs/src/docPages/overview/upgrade-guide.md +++ b/docs/src/docPages/overview/upgrade-guide.md @@ -110,7 +110,7 @@ const CustomExtension = Node.create({ }) ``` -Read more about [all the nifty details building custom extensions](/guide/build-extensions) in our guide. +Read more about [all the nifty details building custom extensions](/guide/custom-extensions) in our guide. ### Renamed settings and methods [We renamed a lot of settings and methods](/api/editor). Hopefully you can migrate to the new API with search & replace. Here is a list of what changed: diff --git a/docs/src/layouts/App/index.vue b/docs/src/layouts/App/index.vue index 4dacb684..bbd15a8b 100644 --- a/docs/src/layouts/App/index.vue +++ b/docs/src/layouts/App/index.vue @@ -57,42 +57,52 @@