Output list items with only text and a nested list as tight list items in fields.markdoc/fields.mdx

.changeset/five-years-attend.md

@@ -0,0 +1,5 @@
+---
+'@keystatic/core': patch
+---
+
+Output list items with only text and a nested list as tight list items in `fields.markdoc`/`fields.mdx`

docs/src/content/pages/reader-api.mdoc

@@ -43,9 +43,7 @@ import keystaticConfig from 'relative/path/to/your/keystatic.config';
 You can then create a new `reader` by calling `createGitHubReader` and passing it the following arguments:
 
 1. The Keystatic config
-
 1. An options object containing:
-
    - `repo`: The name of the content repository on GitHub (e.g. `Thinkmill/keystatic-data`)
    - `token`: The Personal Access Token that allows read access to the repository. This is different from your GitHub App Client ID / Secret in `.env`.
      For information on how to generate PATs, see [GitHub's documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).

packages/keystatic/src/form/fields/markdoc/editor/markdoc/serialize.ts

@@ -233,6 +233,13 @@ export function proseMirrorToMarkdoc(
       listItemContent[0].type === 'paragraph'
     ) {
       listItemContent = listItemContent[0].children;
+    } else if (
+      listItemContent.length === 2 &&
+      listItemContent[0].type === 'paragraph' &&
+      listItemContent[0].children.length === 1 &&
+      listItemContent[1].type === 'list'
+    ) {
+      listItemContent = [listItemContent[0].children[0], listItemContent[1]];
     }
     return new Ast.Node('item', {}, listItemContent);
   }

packages/keystatic/src/form/fields/markdoc/editor/mdx/serialize.ts

@@ -166,7 +166,16 @@ function mapContent<T>(
 }
 
 function convertListItem(listItemContent: BlockContent[]): ListItem {
-  return { type: 'listItem', children: listItemContent };
+  return {
+    type: 'listItem',
+    spread:
+      listItemContent.length === 2 &&
+      listItemContent[0].type === 'paragraph' &&
+      listItemContent[1].type === 'list'
+        ? false
+        : undefined,
+    children: listItemContent,
+  };
 }
 
 export function proseMirrorToMDXRoot(

packages/keystatic/src/form/fields/markdoc/editor/tests/markdoc.test.tsx

@@ -117,7 +117,6 @@ test('nested list', () => {
   );
   expect(markdoc).toMatchInlineSnapshot(`
     "- Something
-
       - Something
     "
   `);

packages/keystatic/src/form/fields/markdoc/editor/tests/mdx.test.tsx

@@ -134,7 +134,6 @@ test('nested list', () => {
   );
   expect(mdx).toMatchInlineSnapshot(`
     "* Something
-
       * Something
 
     "