ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

format tables

Browse Source
This commit is contained in:
Hans Pagel
2020-09-10 10:21:24 +02:00
parent b255ce7634
commit bdb3d2d30a
17 changed files with 99 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/src/docPages/api/extensions.md
View File

@@ -12,24 +12,24 @@ You don’t have to use it, but we prepared a `@tiptap/vue-starter-kit` which in
## List of supported extensions ## List of supported extensions
| Title | Default Extension | Source Code | | Title | Default Extension | Source Code |
| ----- | ------- | ----------- | | ------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------- |
| [Blockquote](/api/extensions/blockquote) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-blockquote/) | [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/) | [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/) | [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/) | [Code](/api/extensions/code) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code/) |
| [Document](/api/extensions/document) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-document/) | [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/) | [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/) | [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/) | [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/) | [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/) | [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/) | [Link](/api/extensions/link) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-link/) |
| [OrderedList](/api/extensions/ordered-list) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-ordered-list/) | [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/) | [Paragraph](/api/extensions/paragraph) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-paragraph/) |
| [Strike](/api/extensions/strike) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/) | [Strike](/api/extensions/strike) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/) |
| [Text](/api/extensions/text) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text/) | [Text](/api/extensions/text) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text/) |
| [Underline](/api/extensions/underline) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/) | [Underline](/api/extensions/underline) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/) |
<!-- | [CodeBlock](/api/extensions/code-block) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-code-block/) --> <!-- | [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-/) --> <!-- | [CodeBlockHighlight](/api/extensions/code-block-highlight) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packagescode-block-highlight/extension-/) -->

12
docs/src/docPages/api/extensions/blockquote.md
View File

@@ -2,14 +2,14 @@
The Blockquote extension enables you to use the `<blockquote>` HTML tag in the editor. The Blockquote extension enables you to use the `<blockquote>` HTML tag in the editor.
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------ | ---- | ---------------- | | ---------- | ------- | ----------------------------- |
| blockquote | — | Wrap content in a blockquote. | | blockquote | — | Wrap content in a blockquote. |
## Keybindings ## Keybindings
* `Control` + `→` * `Control` + `→`

12
docs/src/docPages/api/extensions/bold.md
View File

@@ -6,14 +6,14 @@ The extension will generate the corresponding `<strong>` HTML tags when reading
::: :::
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------- | ------- | ----------- | | ------- | ------- | --------------- |
| bold | — | Mark text bold. | | bold | — | Mark text bold. |
## Keybindings ## Keybindings
* Windows & Linux: `Control` + `B` * Windows & Linux: `Control` + `B`

12
docs/src/docPages/api/extensions/bullet-list.md
View File

@@ -6,14 +6,14 @@ It’s intended to be used with the `ListItem` extension.
::: :::
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------ | ---- | ---------------- | | ----------- | ------- | --------------------- |
| bullet_list | — | Toggle a bullet list. | | bullet_list | — | Toggle a bullet list. |
## Keybindings ## Keybindings
* `Control` + `Shift` + `8` * `Control` + `Shift` + `8`

12
docs/src/docPages/api/extensions/code.md
View File

@@ -2,14 +2,14 @@
The Code extensions enables you to use the `<code>` HTML tag in the editor. If you paste in text with `<code>` tags it will rendered accordingly. The Code extensions enables you to use the `<code>` HTML tag in the editor. If you paste in text with `<code>` tags it will rendered accordingly.
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------- | ------- | ----------- | | ------- | ------- | ------------------------- |
| code | — | Mark text as inline code. | | code | — | Mark text as inline code. |
## Keybindings ## Keybindings
* `Alt` + ` * `Alt` + `

14
docs/src/docPages/api/extensions/heading.md
View File

@@ -2,15 +2,15 @@
Enables you to use headline HTML tags in the editor. Enables you to use headline HTML tags in the editor.
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------------------ | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
| levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are supported. | | levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are supported. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------ | ---- | ---------------- | | ------- | ------- | ----------------------- |
| heading | level | Creates a heading node. | | heading | level | Creates a heading node. |
## Keybindings ## Keybindings
* `Control` + `Shift` + `1` → H1 * `Control` + `Shift` + `1` → H1

8
docs/src/docPages/api/extensions/history.md
View File

@@ -5,10 +5,10 @@ This extension provides history support. All changes to the document will be tra
*None* *None*
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------- | ------- | ----------- | | ------- | ------- | --------------------- |
| undo | — | Undo the last change. | | undo | — | Undo the last change. |
| redo | — | Redo the last change. | | redo | — | Redo the last change. |
## Keybindings ## Keybindings
* Windows & Linux: `Control` + `Z` * Windows & Linux: `Control` + `Z`

12
docs/src/docPages/api/extensions/horizontal-rule.md
View File

@@ -2,14 +2,14 @@
Enables you to use the `<hr>` HTML tag in the editor. Enables you to use the `<hr>` HTML tag in the editor.
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------ | ---- | ---------------- | | --------------- | ------- | ------------------------- |
| horizontal_rule | — | Create a horizontal rule. | | horizontal_rule | — | Create a horizontal rule. |
## Keybindings ## Keybindings
*None* *None*

12
docs/src/docPages/api/extensions/italic.md
View File

@@ -6,14 +6,14 @@ The extension will generate the corresponding `<em>` HTML tags when reading cont
::: :::
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------- | ------- | ----------- | | ------- | ------- | ----------------- |
| italic | — | Mark text italic. | | italic | — | Mark text italic. |
## Keybindings ## Keybindings
* Windows & Linux: `Control` + `I` * Windows & Linux: `Control` + `I`

8
docs/src/docPages/api/extensions/link.md
View File

@@ -2,7 +2,7 @@
Enables you to use the `<a>` HTML tag in the editor. Enables you to use the `<a>` HTML tag in the editor.
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ----------- | ------- | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
| openOnClick | Boolean | true | Specifies if links will be opened on click. | | openOnClick | Boolean | true | Specifies if links will be opened on click. |

6
docs/src/docPages/api/extensions/list-item.md
View File

@@ -6,6 +6,6 @@ This extensions is intended to be used with the `BulletList` or `OrderedList` ex
::: :::
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |

12
docs/src/docPages/api/extensions/ordered-list.md
View File

@@ -6,14 +6,14 @@ This extensions is intended to be used with the `ListItem` extension.
::: :::
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------ | ---- | ---------------- | | ------------ | ------- | ----------------------- |
| ordered_list | — | Toggle an ordered list. | | ordered_list | — | Toggle an ordered list. |
## Keybindings ## Keybindings
* `Control` + `Shift` + `9` * `Control` + `Shift` + `9`

6
docs/src/docPages/api/extensions/paragraph.md
View File

@@ -2,9 +2,9 @@
Yes, the schema is very strict. Without this extension you won’t even be able to use paragraphs in the editor. Yes, the schema is very strict. Without this extension you won’t even be able to use paragraphs in the editor.
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
*None* *None*

12
docs/src/docPages/api/extensions/strike.md
View File

@@ -2,14 +2,14 @@
Enables you to use the `<s>` HTML tag in the editor. Enables you to use the `<s>` HTML tag in the editor.
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------ | ---- | ---------------- | | ------- | ------- | --------------------------- |
| strike | — | Mark text as strikethrough. | | strike | — | Mark text as strikethrough. |
## Keybindings ## Keybindings
* Windows & Linux: `Control` + `D` * Windows & Linux: `Control` + `D`

6
docs/src/docPages/api/extensions/todo-item.md
View File

@@ -6,9 +6,9 @@ This extensions is intended to be used with the `TodoList` extension.
::: :::
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------- | ------- | ------------------------------------- |
| nested | Boolean | false | Specifies if you can nest todo lists. | | nested | Boolean | false | Specifies if you can nest todo lists. |
## Commands ## Commands
*None* *None*

6
docs/src/docPages/api/extensions/todo-list.md
View File

@@ -9,9 +9,9 @@ This extensions is intended to be used with the `TodoItem` extension.
*None* *None*
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------ | ---- | ---------------- | | --------- | ------- | ----------------- |
| todo_list | — | Toggle todo list. | | todo_list | — | Toggle todo list. |
## Keybindings ## Keybindings
*None* *None*

12
docs/src/docPages/api/extensions/underline.md
View File

@@ -2,14 +2,14 @@
Enables you to use the `<u>` HTML tag in the editor. Enables you to use the `<u>` HTML tag in the editor.
## Options ## Options
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------ | ---- | ------- | ----------- | | ------ | ------ | ------- | -------------------------------------------- |
| class | string | – | Add a custom class to the rendered HTML tag. | | class | string | – | Add a custom class to the rendered HTML tag. |
## Commands ## Commands
| Command | Options | Description | | Command | Options | Description |
| ------ | ---- | ---------------- | | --------- | ------- | ------------------------ |
| underline | — | Mark text as underlined. | | underline | — | Mark text as underlined. |
## Keybindings ## Keybindings
* Windows & Linux: `Control` + `U` * Windows & Linux: `Control` + `U`