🏷️ Do not write implicit labels for markdown (#1722)

Co-authored-by: Franklin Koch <franklinwkoch@gmail.com>
jupyter-book · Jan 6, 2025 · 7d6dff2 · 7d6dff2
1 parent 7d916fe
commit 7d6dff2
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 1 deletion.
diff --git a/.changeset/young-moles-trade.md b/.changeset/young-moles-trade.md
@@ -0,0 +1,5 @@
+---
+"myst-to-md": patch
+---
+
+do not write out implicit references for titles
diff --git a/packages/myst-to-md/src/references.ts b/packages/myst-to-md/src/references.ts
@@ -6,7 +6,7 @@ function labelWrapper(handler: Handle) {
   return (node: any, _: Parent, state: NestedState, info: Info): string => {
     const ident = node.identifier ?? node.label;
     const prefix = ident ? `(${ident})=\n` : '';
-    return `${prefix}${handler(node, _, state, info)}`;
+    return `${node.implicit ? '' : prefix}${handler(node, _, state, info)}`;
   };
 }
 

diff --git a/packages/myst-to-md/tests/references.yml b/packages/myst-to-md/tests/references.yml
@@ -60,6 +60,30 @@ cases:
 
       (my-subheading)=
       #### fourth
+  - title: implicitly labeled headings
+    mdast:
+      type: root
+      children:
+        - type: heading
+          depth: 1
+          label: first
+          identifier: first
+          implicit: true
+          children:
+            - type: text
+              value: first
+        - type: paragraph
+          children:
+            - type: text
+              value: 'Some % '
+            - type: emphasis
+              children:
+                - type: text
+                  value: markdown
+    markdown: |-
+      # first
+
+      Some % *markdown*
   - title: labeled quote
     mdast:
       type: root