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

docs: replace embeds with just the URL

Browse Source
This commit is contained in:
Hans Pagel
2021-10-18 18:01:47 +02:00
parent 43a944b897
commit 53f815a53c
79 changed files with 96 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/extensions/bubble-menu.md
View File

@@ -67,7 +67,7 @@ new Editor({
```
### Frameworks
<tiptap-demo name="Extensions/BubbleMenu"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/BubbleMenu
### Custom logic
Customize the logic for showing the menu with the `shouldShow` option. For components, `shouldShow` can be passed as a prop.

2
docs/api/extensions/character-count.md
View File

@@ -36,7 +36,7 @@ CharacterCount.configure({
[packages/extension-character-count/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-character-count/)
## Usage
<tiptap-demo name="Extensions/CharacterCount"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/CharacterCount
## Count words, emojis, letters …
Want to count words instead? Or emojis? Or the letter *a*? Sure, no problem. You can access the `textContent` directly and count whatever you’re into.

4
docs/api/extensions/collaboration-cursor.md
View File

@@ -57,5 +57,5 @@ editor.commands.user({ name: 'Philipp Kühn', color: '#000000' })
:::warning Public
The content of this editor is shared with other users.
:::
<tiptap-demo name="Extensions/CollaborationCursor" hide-source></tiptap-demo>
<tiptap-demo name="Extensions/CollaborationCursor"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/CollaborationCursor?hideSource
https://embed.tiptap.dev/preview/Extensions/CollaborationCursor

4
docs/api/extensions/collaboration.md
View File

@@ -89,5 +89,5 @@ editor.commands.redo()
:::warning Public
The content of this editor is shared with other users.
:::
<tiptap-demo name="Extensions/Collaboration" hide-source></tiptap-demo>
<tiptap-demo name="Extensions/Collaboration"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/Collaboration?hideSource
https://embed.tiptap.dev/preview/Extensions/Collaboration

2
docs/api/extensions/color.md
View File

@@ -53,4 +53,4 @@ editor.commands.unsetColor()
[packages/extension-color/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-color/)
## Usage
<tiptap-demo name="Extensions/Color"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/Color

2
docs/api/extensions/dropcursor.md
View File

@@ -57,4 +57,4 @@ Dropcursor.configure({
[packages/extension-dropcursor/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-dropcursor/)
## Usage
<tiptap-demo name="Extensions/Dropcursor"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/Dropcursor

2
docs/api/extensions/floating-menu.md
View File

@@ -63,7 +63,7 @@ new Editor({
```
## Using a framework
<tiptap-demo name="Extensions/FloatingMenu"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/FloatingMenu
### Custom logic
Customize the logic for showing the menu with the `shouldShow` option. For components, `shouldShow` can be passed as a prop.

2
docs/api/extensions/focus.md
View File

@@ -48,4 +48,4 @@ Focus.configure({
[packages/extension-focus/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-focus/)
## Usage
<tiptap-demo name="Extensions/Focus"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/Focus

2
docs/api/extensions/font-family.md
View File

@@ -52,4 +52,4 @@ editor.commands.unsetFontFamily()
[packages/extension-font-family/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-font-family/)
## Usage
<tiptap-demo name="Extensions/FontFamily"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/FontFamily

2
docs/api/extensions/gapcursor.md
View File

@@ -24,4 +24,4 @@ yarn add @tiptap/extension-gapcursor
[packages/extension-gapcursor/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-gapcursor/)
## Usage
<tiptap-demo name="Extensions/Gapcursor"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/Gapcursor

2
docs/api/extensions/history.md
View File

@@ -67,4 +67,4 @@ editor.commands.redo()
[packages/extension-history/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-history/)
## Usage
<tiptap-demo name="Extensions/History"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/History

2
docs/api/extensions/placeholder.md
View File

@@ -94,4 +94,4 @@ Placeholder.configure({
[packages/extension-placeholder/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-placeholder/)
## Usage
<tiptap-demo name="Extensions/Placeholder"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/Placeholder

2
docs/api/extensions/text-align.md
View File

@@ -86,4 +86,4 @@ editor.commands.unsetTextAlign()
[packages/extension-text-align/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-text-align/)
## Usage
<tiptap-demo name="Extensions/TextAlign"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/TextAlign

2
docs/api/extensions/typography.md
View File

@@ -52,4 +52,4 @@ yarn add @tiptap/extension-typography
[packages/extension-typography/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-typography/)
## Usage
<tiptap-demo name="Extensions/Typography"></tiptap-demo>
https://embed.tiptap.dev/preview/Extensions/Typography

2
docs/api/marks/bold.md
View File

@@ -69,4 +69,4 @@ editor.commands.unsetBold()
[packages/extension-bold/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-bold/)
## Usage
<tiptap-demo name="Marks/Bold"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/Bold

2
docs/api/marks/code.md
View File

@@ -65,4 +65,4 @@ editor.commands.unsetCode()
[packages/extension-code/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code/)
## Usage
<tiptap-demo name="Marks/Code"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/Code

2
docs/api/marks/highlight.md
View File

@@ -79,4 +79,4 @@ editor.commands. unsetHighlight()
[packages/extension-highlight/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-highlight/)
## Usage
<tiptap-demo name="Marks/Highlight"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/Highlight

2
docs/api/marks/italic.md
View File

@@ -69,4 +69,4 @@ editor.commands.unsetItalic()
[packages/extension-italic/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-italic/)
## Usage
<tiptap-demo name="Marks/Italic"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/Italic

2
docs/api/marks/link.md
View File

@@ -99,4 +99,4 @@ this.editor.getAttributes('link').href
[packages/extension-link/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-link/)
## Usage
<tiptap-demo name="Marks/Link"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/Link

2
docs/api/marks/strike.md
View File

@@ -69,4 +69,4 @@ editor.commands.unsetStrike()
[packages/extension-strike/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-strike/)
## Usage
<tiptap-demo name="Marks/Strike"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/Strike

2
docs/api/marks/subscript.md
View File

@@ -63,4 +63,4 @@ editor.commands.unsetSubscript()
[packages/extension-subscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-subscript/)
## Usage
<tiptap-demo name="Marks/Subscript"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/Subscript

2
docs/api/marks/superscript.md
View File

@@ -63,4 +63,4 @@ editor.commands.unsetSuperscript()
[packages/extension-superscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-superscript/)
## Usage
<tiptap-demo name="Marks/Superscript"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/Superscript

2
docs/api/marks/text-style.md
View File

@@ -31,4 +31,4 @@ editor.command.removeEmptyTextStyle()
[packages/extension-text-style/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-text-style/)
## Usage
<tiptap-demo name="Marks/TextStyle"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/TextStyle

2
docs/api/marks/underline.md
View File

@@ -69,4 +69,4 @@ editor.commands.unsetUnderline()
[packages/extension-underline/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-underline/)
## Usage
<tiptap-demo name="Marks/Underline"></tiptap-demo>
https://embed.tiptap.dev/preview/Marks/Underline

2
docs/api/nodes/blockquote.md
View File

@@ -64,4 +64,4 @@ editor.commands.unsetBlockquote()
[packages/extension-blockquote/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-blockquote/)
## Usage
<tiptap-demo name="Nodes/Blockquote"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Blockquote

2
docs/api/nodes/bullet-list.md
View File

@@ -53,4 +53,4 @@ editor.commands.toggleBulletList()
[packages/extension-bullet-list/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-bullet-list/)
## Usage
<tiptap-demo name="Nodes/BulletList"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/BulletList

2
docs/api/nodes/code-block-lowlight.md
View File

@@ -69,4 +69,4 @@ editor.commands.toggleCodeBlock()
[packages/extension-code-block-lowlight/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code-block-lowlight/)
## Usage
<tiptap-demo name="Nodes/CodeBlockLowlight"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/CodeBlockLowlight

2
docs/api/nodes/code-block.md
View File

@@ -73,4 +73,4 @@ editor.commands.toggleCodeBlock()
[packages/extension-code-block/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code-block/)
## Usage
<tiptap-demo name="Nodes/CodeBlock"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/CodeBlock

2
docs/api/nodes/document.md
View File

@@ -28,4 +28,4 @@ yarn add @tiptap/extension-document
[packages/extension-document/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-document/)
## Usage
<tiptap-demo name="Nodes/Document"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Document

2
docs/api/nodes/emoji.md
View File

@@ -21,4 +21,4 @@ You can use any emoji picker, or build your own. Just use [commands](/api/comman
this.editor.chain().focus().insertContent('✨').run()
```
<tiptap-demo name="Nodes/Emoji"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Emoji

2
docs/api/nodes/hard-break.md
View File

@@ -60,4 +60,4 @@ editor.commands.setHardBreak()
[packages/extension-hard-break/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-hard-break/)
## Usage
<tiptap-demo name="Nodes/HardBreak"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/HardBreak

2
docs/api/nodes/heading.md
View File

@@ -74,4 +74,4 @@ editor.commands.toggleHeading({ level: 1 })
[packages/extension-heading/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-heading/)
## Usage
<tiptap-demo name="Nodes/Heading"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Heading

2
docs/api/nodes/horizontal-rule.md
View File

@@ -46,4 +46,4 @@ editor.commands.setHorizontalRule()
[packages/extension-horizontal-rule/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-horizontal-rule/)
## Usage
<tiptap-demo name="Nodes/HorizontalRule"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/HorizontalRule

2
docs/api/nodes/image.md
View File

@@ -62,4 +62,4 @@ editor.commands.setImage({ src: 'https://example.com/foobar.png', alt: 'A boring
[packages/extension-image/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-image/)
## Usage
<tiptap-demo name="Nodes/Image"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Image

2
docs/api/nodes/list-item.md
View File

@@ -44,4 +44,4 @@ ListItem.configure({
[packages/extension-list-item/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-list-item/)
## Usage
<tiptap-demo name="Nodes/ListItem"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/ListItem

2
docs/api/nodes/mention.md
View File

@@ -80,4 +80,4 @@ Mention.configure({
[packages/extension-mention/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-mention/)
## Usage
<tiptap-demo name="Nodes/Mention"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Mention

2
docs/api/nodes/ordered-list.md
View File

@@ -53,4 +53,4 @@ editor.commands.toggleOrderedList()
[packages/extension-ordered-list/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-ordered-list/)
## Usage
<tiptap-demo name="Nodes/OrderedList"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/OrderedList

2
docs/api/nodes/paragraph.md
View File

@@ -53,4 +53,4 @@ editor.commands.setParagraph()
[packages/extension-paragraph/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-paragraph/)
## Usage
<tiptap-demo name="Nodes/Paragraph"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Paragraph

2
docs/api/nodes/table-cell.md
View File

@@ -24,4 +24,4 @@ This extension requires the [`Table`](/api/nodes/table), [`TableRow`](/api/nodes
[packages/extension-table-cell/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-table-cell/)
## Usage
<tiptap-demo name="Nodes/Table"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Table

2
docs/api/nodes/table-header.md
View File

@@ -40,4 +40,4 @@ This extension requires the [`Table`](/api/nodes/table), [`TableRow`](/api/nodes
[packages/extension-table-header/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-table-header/)
## Usage
<tiptap-demo name="Nodes/Table"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Table

2
docs/api/nodes/table-row.md
View File

@@ -24,4 +24,4 @@ This extension requires the [`Table`](/api/nodes/table), [`TableHeader`](/api/no
[packages/extension-table-row/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-table-row/)
## Usage
<tiptap-demo name="Nodes/Table"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Table

2
docs/api/nodes/table.md
View File

@@ -190,4 +190,4 @@ editor.commands.fixTables()
[packages/extension-table/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-table/)
## Usage
<tiptap-demo name="Nodes/Table"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Table

2
docs/api/nodes/task-item.md
View File

@@ -46,4 +46,4 @@ TaskItem.configure({
[packages/extension-task-item/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-task-item/)
## Usage
<tiptap-demo name="Nodes/TaskItem"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/TaskItem

2
docs/api/nodes/task-list.md
View File

@@ -53,4 +53,4 @@ editor.commands.toggleTaskList()
[packages/extension-task-list/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-task-list/)
## Usage
<tiptap-demo name="Nodes/TaskList"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/TaskList

2
docs/api/nodes/text.md
View File

@@ -26,4 +26,4 @@ yarn add @tiptap/extension-text
[packages/extension-text/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-text/)
## Usage
<tiptap-demo name="Nodes/Text"></tiptap-demo>
https://embed.tiptap.dev/preview/Nodes/Text

4
docs/api/utilities/html.md
View File

@@ -10,7 +10,7 @@ All it needs is JSON or a HTML string, and a list of extensions.
[packages/html/](https://github.com/ueberdosis/tiptap/blob/main/packages/html/)
## Generate HTML from JSON
<tiptap-demo name="GuideContent/GenerateHTML"></tiptap-demo>
https://embed.tiptap.dev/preview/GuideContent/GenerateHTML
## Generate JSON from HTML
<tiptap-demo name="GuideContent/GenerateJSON"></tiptap-demo>
https://embed.tiptap.dev/preview/GuideContent/GenerateJSON