diff --git a/docs/src/docPages/extensions.md b/docs/src/docPages/extensions.md index 3dd290d4e..ed4d9847d 100644 --- a/docs/src/docPages/extensions.md +++ b/docs/src/docPages/extensions.md @@ -1 +1,917 @@ -# Extensions \ No newline at end of file +# 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](../commands/basics.md). The official set of commands are part of the +[`tiptap-commands`][@npmjs-tiptap-commands] package. + +## Blockquote +Allows you to use the `
` HTML tag in the editor. + +#### Options +*None* + +#### Commands +| command | options | description | +| ------ | ---- | ---------------- | +| blockquote | none | Wrap content in a blockquote. | + +#### Keybindings +`Ctrl->` + +#### Example +```vue + + + +``` + +## Bold +Renders text in **bold** text weight. If you pass ``, or `` tags, or text with inline `style` attributes setting the `font-weight` CSS rule in the editor's initial content, they will be rendered accordingly. + +::: warning Restrictions +The extension will generate the corresponding `` HTML tags when reading contents of the `Editor` instance. All text marked as bold, regardless of method will be normalized to `` HTML tags. +::: + +#### Options +*None* + +#### Commands +| command | options | description | +| ------ | ---- | ---------------- | +| bold | none | Mark text as bold. | + +#### Keybindings +`Ctrl-b` (on Windows/Linux) +`Cmd-b` (on macOS) + +#### Example + +```vue + + + +``` + +## BulletList +Allows you to use the `