Merge pull request #3789 from udecode/docs/examples

Docs/examples
udecode · Nov 19, 2024 · 95bae9d · 95bae9d
2 parents 1e9b3c1 + e8d1ac0
commit 95bae9d
Show file tree

Hide file tree

Showing 440 changed files with 6,873 additions and 12,535 deletions.
diff --git a/apps/www/content/docs/ai.mdx b/apps/www/content/docs/ai.mdx
@@ -1,12 +1,11 @@
 ---
 title: AI
-description: AI menu with commands, streaming responses in a preview or directly into the editor.
 docs:
   - route: https://pro.platejs.org/docs/examples/ai
     title: AI
 ---
 
-<ComponentPreview name="playground-demo" id="ai" />
+<ComponentPreview name="ai-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/alignment.mdx b/apps/www/content/docs/alignment.mdx
@@ -1,12 +1,11 @@
 ---
 title: Alignment
-description: Align your content to different positions.
 docs:
   - route: /docs/components/align-dropdown-menu
     title: Align Dropdown Menu
 ---
 
-<ComponentPreview name="playground-demo" id="align" />
+<ComponentPreview name="align-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/autoformat.mdx b/apps/www/content/docs/autoformat.mdx
@@ -1,6 +1,5 @@
 ---
 title: Autoformat
-description: Apply formatting automatically using shortcodes.
 docs:
   - route: /docs/basic-elements
     title: Basic Elements
@@ -12,7 +11,7 @@ docs:
     title: List
 ---
 
-<ComponentPreview name="playground-demo" id="autoformat" />
+<ComponentPreview name="autoformat-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/basic-elements.mdx b/apps/www/content/docs/basic-elements.mdx
@@ -1,6 +1,5 @@
 ---
 title: Basic Elements
-description: Enhance your editor with essential formatting elements.
 docs:
   - route: /docs/components/blockquote-element
     title: Block Quote Element
@@ -14,7 +13,7 @@ docs:
     title: Heading Element
 ---
 
-<ComponentPreview name="playground-demo" id="basic-nodes" />
+<ComponentPreview name="basic-elements-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/basic-marks.mdx b/apps/www/content/docs/basic-marks.mdx
@@ -1,12 +1,11 @@
 ---
 title: Basic Marks
-description: Set of essential text formatting options.
 docs:
   - route: /docs/components/mark-toolbar-button
     title: Mark Toolbar Button
 ---
 
-<ComponentPreview name="playground-demo" id="basic-nodes" />
+<ComponentPreview name="basic-marks-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/block-menu.mdx b/apps/www/content/docs/block-menu.mdx
@@ -1,6 +1,5 @@
 ---
 title: Block Menu
-description: Provides quick access to block-specific actions.
 docs:
   - route: /docs/components/block-context-menu
     title: Block Context Menu
@@ -13,7 +12,7 @@ docs:
 
 ---
 
-<ComponentPreview name="playground-demo" id="block-menu" />
+<ComponentPreview name="block-menu-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/block-selection.mdx b/apps/www/content/docs/block-selection.mdx
@@ -1,9 +1,8 @@
 ---
 title: Block Selection
-description: Select and manipulate entire text blocks.
 ---
 
-<ComponentPreview name="playground-demo" id="block-selection" />
+<ComponentPreview name="block-selection-demo" />
 
 <PackageInfo>
 
@@ -79,10 +78,9 @@ Default configuration:
 BlockSelectionPlugin.configure({
   options: {
     areaOptions: {
-    boundaries: `#${editor.uid}`,
-    container: `#${editor.uid}`,
-    selectables: `#${editor.uid} .slate-selectable`,
-      },
+      boundaries: `#${editor.uid}`,
+      container: `#${editor.uid}`,
+      selectables: `#${editor.uid} .slate-selectable`,
     },
   },
 });

diff --git a/apps/www/content/docs/callout.mdx b/apps/www/content/docs/callout.mdx
@@ -1,6 +1,5 @@
 ---
 title: Callout
-description: Highlight important information or add special notes.
 docs:
   - route: https://pro.platejs.org/docs/components/callout-element
     title: Callout Element

diff --git a/apps/www/content/docs/caption.mdx b/apps/www/content/docs/caption.mdx
@@ -1,12 +1,11 @@
 ---
 title: Caption
-description: Add captions to your blocks.
 docs:
   - route: /docs/components/draggable
     title: Draggable
 ---
 
-<ComponentPreview name="playground-demo" id="media" />
+<ComponentPreview name="media-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/collaboration.mdx b/apps/www/content/docs/collaboration.mdx
@@ -1,6 +1,5 @@
 ---
 title: Collaboration
-description: Collaborate with others in a single document.
 ---
 
 <Callout className="my-4">

diff --git a/apps/www/content/docs/column.mdx b/apps/www/content/docs/column.mdx
@@ -1,14 +1,13 @@
 ---
 title: Column
-description: Add Columns to your document.
 docs:
   - route: /docs/components/column-element
     title: Column Element
   - route: /docs/components/column-group-element
     title: Column Group Element
 ---
 
-<ComponentPreview name="playground-demo" id="column" />
+<ComponentPreview name="column-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/combobox.mdx b/apps/www/content/docs/combobox.mdx
@@ -1,6 +1,5 @@
 ---
 title: Combobox
-description: Utilities for adding comboboxes to your editor.
 ---
 
 The `TriggerComboboxPluginOptions` mixin configures your plugin to insert a combobox input element when the user types a specified trigger character.

diff --git a/apps/www/content/docs/comments.mdx b/apps/www/content/docs/comments.mdx
@@ -1,6 +1,5 @@
 ---
 title: Comments
-description: Add comments to text as marks.
 docs:
   - route: /docs/components/comment-leaf
     title: Comment Leaf
@@ -10,7 +9,7 @@ docs:
     title: Comments Popover
 ---
 
-<ComponentPreview name="playground-demo" id="comment" />
+<ComponentPreview name="comments-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/components/changelog.mdx b/apps/www/content/docs/components/changelog.mdx
@@ -13,8 +13,8 @@ Use the [CLI](https://platejs.org/docs/components/cli) to install the latest ver
 
 ### November 14 #16.7
 
-Add `ToolbarSplitButton`, `ToolbarSplitButtonPrimary`, `ToolbarSplitButtonSecondary` in `toolbar.tsx`.
-Refactor `media-toolbar-button.tsx` to use the new split button.
+- `toolbar`: Add `ToolbarSplitButton`, `ToolbarSplitButtonPrimary`, `ToolbarSplitButtonSecondary`
+- `media-toolbar-button`: use `ToolbarSplitButton`
 
 ### November 13 #16.6
 

diff --git a/apps/www/content/docs/components/index.mdx → .../content/docs/components/introduction.mdx b/apps/www/content/docs/components/index.mdx → .../content/docs/components/introduction.mdx
diff --git a/apps/www/content/docs/copilot.mdx b/apps/www/content/docs/copilot.mdx
@@ -1,14 +1,13 @@
 ---
 title: Copilot
-description: Render AI suggestions ghost text as you type.
 docs:
   - route: /docs/components/ghost-text
     title: Ghost Text
   - route: https://pro.platejs.org/docs/components/ghost-text
     title: Ghost Text
 ---
 
-<ComponentPreview name="playground-demo" id="copilot" />
+<ComponentPreview name="copilot-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/csv.mdx b/apps/www/content/docs/csv.mdx
@@ -1,9 +1,8 @@
 ---
 title: Serializing CSV
-description: Copy paste from CSV to Slate.
 ---
 
-<ComponentPreview name="playground-demo" id="csv" />
+<ComponentPreview name="csv-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/cursor-overlay.mdx b/apps/www/content/docs/cursor-overlay.mdx
@@ -1,12 +1,11 @@
 ---
 title: Cursor Overlay
-description: A visual overlay for cursors and selections.
 docs:
   - route: /docs/components/cursor-overlay
     title: Cursor Overlay
 ---
 
-<ComponentPreview name="playground-demo" id="cursor-overlay" />
+<ComponentPreview name="cursor-overlay-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/date.mdx b/apps/www/content/docs/date.mdx
@@ -1,12 +1,11 @@
 ---
 title: Date
-description: Insert and format dates in your document.
 docs:
   - route: /docs/components/date-element
     title: Date Element
 ---
 
-<ComponentPreview name="playground-demo" id="date" />
+<ComponentPreview name="date-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/dnd.mdx b/apps/www/content/docs/dnd.mdx
@@ -1,12 +1,11 @@
 ---
 title: Drag & Drop
-description: Allows movement of blocks, such as paragraph or tables, within the editor.
 docs:
   - route: /docs/components/draggable
     title: Draggable
 ---
 
-<ComponentPreview name="playground-demo" id="dnd" />
+<ComponentPreview name="dnd-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/docx.mdx b/apps/www/content/docs/docx.mdx
@@ -1,9 +1,8 @@
 ---
 title: Serializing Docx
-description: Copy paste from DOCX to Slate.
 ---
 
-<ComponentPreview name="playground-demo" id="docx" />
+<ComponentPreview name="docx-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/emoji.mdx b/apps/www/content/docs/emoji.mdx
@@ -1,6 +1,5 @@
 ---
 title: Emoji
-description: Insert emoji inline.
 docs:
   - route: /docs/combobox
     title: Combobox
@@ -12,7 +11,7 @@ docs:
     title: Emoji Toolbar Dropdown
 ---
 
-<ComponentPreview name="playground-demo" id="emoji" />
+<ComponentPreview name="emoji-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/equation.mdx b/apps/www/content/docs/equation.mdx
@@ -1,6 +1,5 @@
 ---
 title: Equation
-description: Enables the insertion and rendering of LaTeX equations in your editor.
 docs:
   - route: https://pro.platejs.org/docs/components/equation-element
     title: Equation Element

diff --git a/apps/www/content/docs/examples/editable-voids.mdx b/apps/www/content/docs/examples/editable-voids.mdx
@@ -1,6 +1,5 @@
 ---
 title: Editable Voids
-description: Nest editors in void nodes.
 ---
 
 <ComponentPreview name="editable-voids-demo" />
diff --git a/apps/www/content/docs/examples/hundreds-blocks.mdx b/apps/www/content/docs/examples/hundreds-blocks.mdx
@@ -1,6 +1,5 @@
 ---
 title: Hundreds Blocks
-description: Render an editor with 700 blocks.
 ---
 
 <ComponentPreview name="hundreds-blocks-demo" />
diff --git a/apps/www/content/docs/examples/hundreds-editors.mdx b/apps/www/content/docs/examples/hundreds-editors.mdx
@@ -1,6 +1,5 @@
 ---
 title: Hundreds Editors
-description: Render 300 editors.
 ---
 
 <ComponentPreview name="hundreds-editors-demo" />
diff --git a/apps/www/content/docs/examples/iframe.mdx b/apps/www/content/docs/examples/iframe.mdx
@@ -1,6 +1,5 @@
 ---
 title: IFrame
-description: Rendering in iframes.
 ---
 
 <ComponentPreview name="iframe-demo" />
diff --git a/apps/www/content/docs/examples/preview-markdown.mdx b/apps/www/content/docs/examples/preview-markdown.mdx
@@ -1,6 +1,5 @@
 ---
 title: Preview Markdown
-description: Decorate texts with markdown preview.
 ---
 
-<ComponentPreview name="preview-md-demo" />
+<ComponentPreview name="preview-markdown-demo" />
diff --git a/apps/www/content/docs/examples/version-history.mdx b/apps/www/content/docs/examples/version-history.mdx
@@ -1,6 +1,5 @@
 ---
 title: Version History
-description: Show a diff of two different points in a Plate document's history.
 ---
 
 

diff --git a/apps/www/content/docs/excalidraw.mdx b/apps/www/content/docs/excalidraw.mdx
@@ -1,12 +1,11 @@
 ---
 title: Excalidraw
-description: Create drawings and diagrams as block nodes.
 docs:
   - route: /docs/components/excalidraw-element
     title: Excalidraw Element
 ---
 
-<ComponentPreview name="playground-demo" id="excalidraw" />
+<ComponentPreview name="excalidraw-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/exit-break.mdx b/apps/www/content/docs/exit-break.mdx
@@ -1,9 +1,8 @@
 ---
 title: Exit Break
-description: Exit a large block using a shortcut.
 ---
 
-<ComponentPreview name="playground-demo" id="exit-break" />
+<ComponentPreview name="exit-break-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/font.mdx b/apps/www/content/docs/font.mdx
@@ -6,7 +6,7 @@ docs:
     title: Color Dropdown Menu
 ---
 
-<ComponentPreview name="playground-demo" id="font" />
+<ComponentPreview name="font-demo" />
 
 <PackageInfo>
 

diff --git a/apps/www/content/docs/forced-layout.mdx b/apps/www/content/docs/forced-layout.mdx
@@ -1,9 +1,8 @@
 ---
 title: Forced Layout
-description: Strict document structure.
 ---
 
-{/* <ComponentPreview name="playground-demo" id="forced-layout" /> */}
+{/* <ComponentPreview name="forced-layout-demo" /> */}
 
 <PackageInfo>