Add superscript and subscript to known HTML

See #418
jupyter-book · Oct 16, 2023 · f6b10b3 · f6b10b3
1 parent 93cf5ae
commit f6b10b3
Show file tree

Hide file tree

Showing 2 changed files with 90 additions and 1 deletion.
diff --git a/packages/myst-transforms/src/html.spec.ts b/packages/myst-transforms/src/html.spec.ts
@@ -336,4 +336,87 @@ describe('Test reconstructHtmlTransform', () => {
       ],
     });
   });
+  test('no paragraph when in a paragraph', async () => {
+    const mdast = {
+      type: 'root',
+      children: [
+        {
+          type: 'paragraph',
+          children: [
+            {
+              type: 'text',
+              value: 'See ',
+            },
+            {
+              type: 'html',
+              value: '<sup>',
+            },
+            {
+              type: 'text',
+              value: '[1]',
+            },
+            {
+              type: 'html',
+              value: '</sup>',
+            },
+            {
+              type: 'text',
+              value: '.',
+            },
+          ],
+        },
+      ],
+    };
+    reconstructHtmlTransform(mdast);
+    expect(mdast).toEqual({
+      type: 'root',
+      children: [
+        {
+          type: 'paragraph',
+          children: [
+            {
+              type: 'text',
+              value: 'See ',
+            },
+            {
+              type: 'html',
+              value: '<sup>[1]</sup>',
+            },
+            {
+              type: 'text',
+              value: '.',
+            },
+          ],
+        },
+      ],
+    });
+    htmlTransform(mdast);
+    expect(mdast).toEqual({
+      type: 'root',
+      children: [
+        {
+          type: 'paragraph',
+          children: [
+            {
+              type: 'text',
+              value: 'See ',
+            },
+            {
+              type: 'superscript',
+              children: [
+                {
+                  type: 'text',
+                  value: '[1]',
+                },
+              ],
+            },
+            {
+              type: 'text',
+              value: '.',
+            },
+          ],
+        },
+      ],
+    });
+  });
 });
diff --git a/packages/myst-transforms/src/html.ts b/packages/myst-transforms/src/html.ts
@@ -66,12 +66,18 @@ const defaultHtmlToMdastOptions: Record<keyof HtmlTransformOptions, any> = {
     figcaption(h: H, node: any) {
       return h(node, 'caption', all(h, node));
     },
-    comment(h: any, node: any) {
+    comment(h: H, node: any) {
       // Prevents HTML comments from showing up as text in web
       const result = h(node, 'comment');
       (result as any).value = node.value;
       return result;
     },
+    sup(h: H, node: any) {
+      return h(node, 'superscript', all(h, node));
+    },
+    sub(h: H, node: any) {
+      return h(node, 'subscript', all(h, node));
+    },
   },
 };