📋 New lines in markdown lists are not written to typst (#1777)

Fixes #1767
jupyter-book · Jan 14, 2025 · 7f29af8 · 7f29af8
1 parent 884bd8d
commit 7f29af8
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 3 deletions.
diff --git a/.changeset/three-moles-give.md b/.changeset/three-moles-give.md
@@ -0,0 +1,5 @@
+---
+"myst-to-typst": patch
+---
+
+New lines in lists are not written to typst
diff --git a/packages/myst-to-typst/src/index.ts b/packages/myst-to-typst/src/index.ts
@@ -106,7 +106,9 @@ function nextCharacterIsText(parent: GenericNode, node: GenericNode): boolean {
 
 const handlers: Record<string, Handler> = {
   text(node, state) {
-    state.text(node.value);
+    // We do not want markdown formatting to be carried over to typst
+    // As the meaning in lists, etc. is different
+    state.text(node.value.replaceAll('\n', ' '));
   },
   paragraph(node, state) {
     const { identifier } = node;

diff --git a/packages/myst-to-typst/tests/lists.yml b/packages/myst-to-typst/tests/lists.yml
@@ -1,6 +1,6 @@
-title: myst-to-typst admonitions
+title: myst-to-typst lists
 cases:
-  - title: important admonition
+  - title: important list
     mdast:
       type: root
       children:
@@ -25,3 +25,27 @@ cases:
       - This is a list
         + My other, nested
         + bullet point list!
+  - title: List with new lines
+    mdast:
+      type: root
+      children:
+        - type: list
+          children:
+            - type: listItem
+              spread: true
+              children:
+                - type: text
+                  value: |-
+                    A list
+                    with a new line
+            - type: listItem
+              spread: true
+              children:
+                - type: text
+                  value: |
+                    And math
+                - type: inlineMath
+                  value: Ax=b
+    typst: |-
+      - A list with a new line
+      - And math $A x = b$