@@ -67,6 +67,8 @@ export default {
`,
extensions: defaultExtensions(),
})
+
+ window.editor = this.editor
},
beforeDestroy() {
diff --git a/docs/src/demos/Examples/Basic/style.scss b/docs/src/demos/Examples/Basic/style.scss
deleted file mode 100644
index 6e7bccb6..00000000
--- a/docs/src/demos/Examples/Basic/style.scss
+++ /dev/null
@@ -1,3 +0,0 @@
-.this-is-a-test {
- color: black;
-}
\ No newline at end of file
diff --git a/docs/src/docPages/api/extensions.md b/docs/src/docPages/api/extensions.md
index 480b984d..c3d63716 100644
--- a/docs/src/docPages/api/extensions.md
+++ b/docs/src/docPages/api/extensions.md
@@ -1,32 +1,55 @@
# Extensions
-> ⚠️ TODO: This is old content.
-
-By default, the editor will only support paragraphs. Other nodes and marks are available as **extensions**. You must
-install `tiptap-extensions` package separately so that you can use basic Nodes, Marks, or Plugins. An extension is
-usually tied to a Command. The official set of commands are part of the
-[`tiptap-commands`][@npmjs-tiptap-commands] package.
-
-## Default extensions
-
-Starterkits have defaultExtensions, that include ...
+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
-Document, Paragraph, Text
+You’ll need at least three extensions: Document, Paragraph and Text. See [an example of a tiptap version for minimalists](/examples/simple).
-## List of extensions
+## Default extensions
-* Bold
-* Italic
-...
+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 Extensions | Source Code |
+| ----- | ------- | ----------- |
+| [Blockquote](/api/extensions/blockquote) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-blockquote/)
+| [Bold](/api/extensions/bold) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/)
+| [BulletList](/api/extensions/bullet-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bullet-list/)
+| [Code](/api/extensions/code) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code/)
+| [CodeBlock](/api/extensions/code-block) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code-block/)
+| [CodeBlockHighlight](/api/extensions/code-block-highlight) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packagescode-block-highlight/extension-/)
+| [Collaboration](/api/extensions/collaboration) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-collaboration/)
+| [Document](/api/extensions/document) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-document/)
+| [HardBreak](/api/extensions/hard-break) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-hard-break/)
+| [Heading](/api/extensions/heading) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-heading/)
+| [History](/api/extensions/history) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-history/)
+| [HorizontalRule](/api/extensions/horizontal-rule) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-horizontal-rule/)
+| [Italic](/api/extensions/italic) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-italic/)
+| [Link](/api/extensions/link) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-link/)
+| [ListItem](/api/extensions/list-item) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-list-item/)
+| [Mention](/api/extensions/mention) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-mention/)
+| [OrderedList](/api/extensions/ordered-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-ordered-list/)
+| [Paragraph](/api/extensions/paragraph) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-paragraph/)
+| [Placeholder](/api/extensions/placeholder) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-placeholder/)
+| [Strike](/api/extensions/strike) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/)
+| [TableCell](/api/extensions/table-cell) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-table-cell/)
+| [TableHeader](/api/extensions/table-header) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-table-header/)
+| [TableTow](/api/extensions/table-row) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-table-row/)
+| [Text](/api/extensions/text) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text/)
+| [TodoItem](/api/extensions/todo-item) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-todo-item/)
+| [TodoList](/api/extensions/todo-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-todo-list/)
+| [Underline](/api/extensions/underline) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/)
## Community extensions
-How does that work?
+:::warning Work in Progress
+This section is not ready yet. Meanwhile, [search through the GitHub issues](https://github.com/ueberdosis/tiptap/issues) to find code snippets.
+:::
## Your custom extensions
-Link to the Guide
+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/api/extensions/bold.md b/docs/src/docPages/api/extensions/bold.md
index b3380de5..fb29a364 100644
--- a/docs/src/docPages/api/extensions/bold.md
+++ b/docs/src/docPages/api/extensions/bold.md
@@ -10,7 +10,7 @@ The extension will generate the corresponding `` HTML tags when reading
## Commands
| Command | Options | Description |
-| ------ | ---- | ---------------- |
+| ------- | ------- | ----------- |
| bold | — | Mark text bold. |
## Keybindings
diff --git a/docs/src/docPages/api/extensions/document.md b/docs/src/docPages/api/extensions/document.md
new file mode 100644
index 00000000..eb9d8f65
--- /dev/null
+++ b/docs/src/docPages/api/extensions/document.md
@@ -0,0 +1 @@
+# Document
\ No newline at end of file
diff --git a/docs/src/links.yaml b/docs/src/links.yaml
index 8f41ee62..249d8f28 100644
--- a/docs/src/links.yaml
+++ b/docs/src/links.yaml
@@ -96,6 +96,8 @@
link: /api/extensions/code-block-highlight
- title: Collaboration
link: /api/extensions/collaboration
+ - title: Document
+ link: /api/extensions/document
- title: Hardbreak
link: /api/extensions/hard-break
- title: Heading
@@ -114,10 +116,14 @@
link: /api/extensions/mention
- title: OrderedList
link: /api/extensions/ordered-list
+ - title: Paragraph
+ link: /api/extensions/paragraph
- title: Placeholder
link: /api/extensions/placeholder
- title: Strike
link: /api/extensions/strike
+ - title: Text
+ link: /api/extensions/text
- title: TableCell
link: /api/extensions/table-cell
- title: TableHeader
diff --git a/packages/extension-codeblock/index.ts b/packages/extension-codeblock/index.ts
index 6c926c38..96ed30dc 100644
--- a/packages/extension-codeblock/index.ts
+++ b/packages/extension-codeblock/index.ts
@@ -8,7 +8,7 @@ export default class CodeBlock extends Node {
schema(): NodeSpec {
return {
content: 'text*',
- marks: '',
+ marks: '',
group: 'block',
code: true,
defining: true,