docs

Author: felixfeng33

.changeset/funny-fishes-design.md

@@ -2,31 +2,6 @@
 '@udecode/plate-markdown': minor
 ---
 
-When serializing an incomplete MDX file, we encounter an error. To address this, the solution is to remove the remark mdx plugin causing the issue.
+- Added fallback handling for unsupported MDX tags to gracefully preserve content
 
-To make the remarkMdx plugin discoverable, we’ve introduced `tagRemarkPlugin`.
-
-```tsx
-    remarkPlugins: [
-      remarkMath,
-      remarkGfm,
-      tagRemarkPlugin(remarkMdx, REMARK_MDX_TAG),
-      remarkMention,
-    ],
-```
-
-After that we can use the following code with `withoutMdx` option to solve this issue.
-
-```tsx
-try {
-  const nodes = editor.getApi(MarkdownPlugin).markdown.deserialize(text);
-  return nodes;
-} catch (error) {
-  const nodes = editor.getApi(MarkdownPlugin).markdown.deserialize(text, {
-    withoutMdx: true,
-  });
-  return nodes;
-}
-```
-
-The previous approach relied on using name for filtering, but this proved to be unreliable—name can be minified during the build process, making it inconsistent.
+- Now remarkMdx is exported directly from the `@udecode/plate-markdown` package instead of importing from `remark-mdx`

apps/www/package.json

@@ -158,7 +158,6 @@
     "remark-emoji": "5.0.1",
     "remark-gfm": "^4.0.0",
     "remark-math": "^6.0.0",
-    "remark-mdx": "^3.1.0",
     "sass": "1.83.4",
     "shadcx": "workspace:^",
     "sonner": "1.7.4",

apps/www/src/registry/default/components/editor/plugins/markdown-plugin.tsx

@@ -2,23 +2,16 @@
 
 import {
   MarkdownPlugin,
-  REMARK_MDX_TAG,
+  remarkMdx,
   remarkMention,
-  tagRemarkPlugin,
 } from '@udecode/plate-markdown';
 import { SuggestionPlugin } from '@udecode/plate-suggestion/react';
 import remarkGfm from 'remark-gfm';
 import remarkMath from 'remark-math';
-import remarkMdx from 'remark-mdx';
 
 export const markdownPlugin = MarkdownPlugin.configure({
   options: {
     disallowedNodes: [SuggestionPlugin.key],
-    remarkPlugins: [
-      remarkMath,
-      remarkGfm,
-      tagRemarkPlugin(remarkMdx, REMARK_MDX_TAG),
-      remarkMention,
-    ],
+    remarkPlugins: [remarkMath, remarkGfm, remarkMdx, remarkMention],
   },
 });

apps/www/src/registry/registry-components.ts

@@ -265,7 +265,6 @@ const plugins: Registry['items'] = [
       '@udecode/plate-markdown',
       'remark-gfm',
       'remark-math',
-      'remark-mdx',
     ],
     files: [
       {

packages/markdown/package.json

@@ -50,6 +50,7 @@
     "marked": "^15.0.6",
     "mdast-util-math": "3.0.0",
     "mdast-util-mdx": "3.0.0",
+    "remark-mdx": "^3.1.0",
     "remark-parse": "^11.0.0",
     "remark-stringify": "^11.0.0",
     "unified": "^11.0.5",

packages/markdown/src/lib/plugins/index.ts

@@ -2,4 +2,5 @@
  * @file Automatically generated by barrelsby.
  */
 
+export * from './remarkMdx';
 export * from './remarkMention';

packages/markdown/src/lib/plugins/remarkMdx.ts

@@ -0,0 +1,5 @@
+import baseRemarkMdx from 'remark-mdx';
+
+import { REMARK_MDX_TAG , tagRemarkPlugin } from '../utils';
+
+export const remarkMdx = tagRemarkPlugin(baseRemarkMdx, REMARK_MDX_TAG) as typeof baseRemarkMdx;

yarn.lock

@@ -6849,6 +6849,7 @@ __metadata:
     marked: "npm:^15.0.6"
     mdast-util-math: "npm:3.0.0"
     mdast-util-mdx: "npm:3.0.0"
+    remark-mdx: "npm:^3.1.0"
     remark-parse: "npm:^11.0.0"
     remark-stringify: "npm:^11.0.0"
     unified: "npm:^11.0.5"
@@ -22163,7 +22164,6 @@ __metadata:
     remark-emoji: "npm:5.0.1"
     remark-gfm: "npm:^4.0.0"
     remark-math: "npm:^6.0.0"
-    remark-mdx: "npm:^3.1.0"
     rimraf: "npm:6.0.1"
     sass: "npm:1.83.4"
     shadcx: "workspace:^"