diff --git a/docs/src/demos/BasicConfiguration/index.vue b/docs/src/demos/ExtensionConfiguration/index.vue similarity index 75% rename from docs/src/demos/BasicConfiguration/index.vue rename to docs/src/demos/ExtensionConfiguration/index.vue index cdf7e1a8..e2842584 100644 --- a/docs/src/demos/BasicConfiguration/index.vue +++ b/docs/src/demos/ExtensionConfiguration/index.vue @@ -1,17 +1,5 @@ @@ -19,11 +7,12 @@ \ No newline at end of file diff --git a/docs/src/docPages/configuration.md b/docs/src/docPages/configuration.md index 9c85d8b7..1d1ebdae 100644 --- a/docs/src/docPages/configuration.md +++ b/docs/src/docPages/configuration.md @@ -2,6 +2,28 @@ In its basic version tiptap comes very raw. There is no menu, no buttons, no styling. That’s intended. See tiptap as your building blocks to build exactly the editor you’d like to have. -Let’s start to add a few basic things to the configuration. +## Adding a menu - \ No newline at end of file +Let’s start to add your first button to the editor. + + + +Once initiated the editor has a powerful API. So called commands allow you to modify the text. In this example `this.editor.commands.bold` marks the selected text bold. There a ton of other commands (see the [list of available commands](/commands/)) and you can even chain them to do multiple things at once. + +For most use cases you want to + +## Configure extensions + +You are free to choose which parts of tiptap you want to use. Tiptap has support for different nodes (paragraphs, blockquotes, tables and many more) and different marks (bold, italic, links). If you want to explicitly configure what kind of nodes and marks are allowed and which are not allowed, you can configure those. + +Note that `Document`, `Paragraph` and `Text` are required. Otherwise you won’t be able to add any plain text. + + + +That’s also the place where you can register custom extensions, which you or someone else built for tiptap. + +## Related links + +* List of all available Commands +* List of all available Extensions +* Build custom Extensions \ No newline at end of file diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 4d2aa28b..f8aea303 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -17,7 +17,7 @@ link: /custom-styling/ - title: Get content ❌ link: /get-content/ - - title: Advanced nodes ❌ + - title: Custom extensions ❌ link: /advanced-notes/ - title: Vue