Merge pull request #4440 from udecode/claude/issue-4438-20250701_103048

fix(markdown): add spread option to control list spacing

Author: felixfeng33

.changeset/markdown-spread-option.md

@@ -0,0 +1,22 @@
+---
+"@platejs/markdown": patch
+---
+
+Added `spread` option to control list spacing in markdown serialization.
+
+Added a new optional `spread` property to `SerializeMdOptions`:
+- When `spread` is `false` (default), lists are rendered compactly
+- When `spread` is `true`, lists have double line breaks between items
+
+Before (default):
+```markdown
+1. Item 1
+2. Item 2
+```
+
+After (with `spread: true`):
+```markdown
+1. Item 1
+
+2. Item 2
+```

packages/core/CHANGELOG.md

@@ -6,30 +6,7 @@
 
 - [#4441](https://github.com/udecode/plate/pull/4441) by [@delijah](https://github.com/delijah) – Expose mimeType to plugin parser functions
 
-  Added comprehensive copy functionality and view editor support for static rendering.
-
-  **New Components:**
-
-  - Added `PlateView` component for static editor rendering with copy support
-  - Added `usePlateViewEditor` hook for creating memoized static editors
-
-  **Static Editor Enhancements:**
-
-  - Added `withStatic` HOC to enhance editors with static rendering capabilities
-  - Added `ViewPlugin` that enables copy operations in static editors
-  - Added `getStaticPlugins` to configure plugins for static rendering
-  - Added `onCopy` handler that properly serializes content with `x-slate-fragment` format
-
-  **New Utilities:**
-
-  - Added `getSelectedDomBlocks` to extract selected DOM elements with Slate metadata
-  - Added `getSelectedDomNode` to get DOM nodes from browser selection
-  - Added `isSelectOutside` to check if selection is outside editor bounds
-  - Added `getPlainText` to recursively extract plain text from DOM nodes
-
-  This enables seamless copy operations from static Plate editors, allowing content to be pasted into other Slate editors while preserving rich formatting and structure.
-
-- [`a6c3e52`](https://github.com/udecode/plate/commit/a6c3e521c2cd8410d151f0b99a9080bba171b276) by [@felixfeng33](https://github.com/felixfeng33) – Added comprehensive copy functionality and view editor support for static rendering.
+- [#4431](https://github.com/udecode/plate/pull/4431) by [@felixfeng33](https://github.com/felixfeng33) – Added comprehensive copy functionality and view editor support for static rendering.
 
   **New Components:**
 

packages/markdown/src/lib/serializer/__snapshots__/listToMdastTree.spec.ts.snap

@@ -35,6 +35,7 @@ exports[`listToMdastTree should handle todo lists correctly 1`] = `
     },
   ],
   "ordered": false,
+  "spread": false,
   "start": 1,
   "type": "list",
 }

packages/markdown/src/lib/serializer/listToMdastTree.spec.ts

@@ -50,6 +50,7 @@ describe('listToMdastTree', () => {
         },
       ],
       ordered: false,
+      spread: false,
       start: 1,
       type: 'list',
     });
@@ -117,6 +118,7 @@ describe('listToMdastTree', () => {
                 },
               ],
               ordered: false,
+              spread: false,
               start: 1,
               type: 'list',
             },
@@ -125,6 +127,7 @@ describe('listToMdastTree', () => {
         },
       ],
       ordered: false,
+      spread: false,
       start: 1,
       type: 'list',
     });
@@ -176,6 +179,7 @@ describe('listToMdastTree', () => {
         },
       ],
       ordered: true,
+      spread: false,
       start: 1,
       type: 'list',
     });
@@ -431,4 +435,38 @@ describe('listToMdastTree', () => {
 
     expect(result).toMatchSnapshot();
   });
+
+  it('should handle spread option correctly', () => {
+    const nodes = [
+      {
+        children: [{ text: 'list1' }],
+        indent: 1,
+        listStart: 1,
+        listStyleType: 'disc',
+        type: 'p',
+      },
+      {
+        children: [{ text: 'list2' }],
+        indent: 1,
+        listStart: 1,
+        listStyleType: 'disc',
+        type: 'p',
+      },
+    ];
+
+    // Test with spread: false (default)
+    const resultNoSpread = listToMdastTree(nodes as any, {
+      editor,
+    });
+
+    expect(resultNoSpread.spread).toBe(false);
+
+    // Test with spread: true
+    const resultWithSpread = listToMdastTree(nodes as any, {
+      editor,
+      spread: true,
+    });
+
+    expect(resultWithSpread.spread).toBe(true);
+  });
 });

packages/markdown/src/lib/serializer/listToMdastTree.ts

@@ -16,6 +16,7 @@ export function listToMdastTree(
   const root: MdList = {
     children: [],
     ordered: nodes[0].listStyleType === 'decimal',
+    spread: options.spread ?? false,
     start: nodes[0].listStart,
     type: 'list',
   };
@@ -57,7 +58,12 @@ export function listToMdastTree(
         },
       ],
       type: 'listItem',
-    };
+    } as any;
+
+    // Add spread property to list items when spread is true
+    if (options.spread) {
+      (listItem as any).spread = true;
+    }
 
     // Add checked property for todo lists
     if (node.listStyleType === 'todo' && node.checked !== undefined) {
@@ -74,6 +80,7 @@ export function listToMdastTree(
       const nestedList: MdList = {
         children: [],
         ordered: nextNode.listStyleType === 'decimal',
+        spread: options.spread ?? false,
         start: nextNode.listStart,
         type: 'list',
       };

packages/markdown/src/lib/serializer/serializeMd.spec.ts

@@ -5,7 +5,10 @@ const editor = createTestEditor();
 
 describe('serializeMd', () => {
   it('should serialize a simple paragraph', () => {
-    const result = serializeMd(editor as any, { value: testValue });
+    const result = serializeMd(editor as any, {
+      spread: true,
+      value: testValue,
+    });
     expect(result).toMatchSnapshot();
   });
 
@@ -266,4 +269,33 @@ describe('serializeMd', () => {
       ).toMatchSnapshot();
     }
   );
+
+  it('should serialize lists with spread option correctly', () => {
+    const listFragment = [
+      {
+        children: [{ text: '1' }],
+        indent: 1,
+        listStyleType: 'decimal',
+        type: 'p',
+      },
+      {
+        children: [{ text: '2' }],
+        indent: 1,
+        listStart: 2,
+        listStyleType: 'decimal',
+        type: 'p',
+      },
+    ];
+
+    // Test with default (spread: false)
+    const resultDefault = serializeMd(editor as any, { value: listFragment });
+    expect(resultDefault).toBe('1. 1\n2. 2\n');
+
+    // Test with spread: true
+    const resultWithSpread = serializeMd(editor as any, {
+      spread: true,
+      value: listFragment,
+    });
+    expect(resultWithSpread).toBe('1. 1\n\n2. 2\n');
+  });
 });

packages/markdown/src/lib/serializer/serializeMd.ts

@@ -17,6 +17,7 @@ export type SerializeMdOptions = {
   preserveEmptyParagraphs?: boolean;
   remarkPlugins?: Plugin[];
   rules?: MdRules;
+  spread?: boolean;
   value?: Descendant[];
 };
 

packages/markdown/src/lib/serializer/utils/getMergedOptionsSerialize.ts

@@ -38,6 +38,7 @@ export const getMergedOptionsSerialize = (
     editor,
     remarkPlugins: options?.remarkPlugins ?? PluginRemarkPlugins ?? [],
     rules: mergedRules,
+    spread: options?.spread,
     value: options?.value ?? editor.children,
   };
 };