feat: Add sanitizeHeading function to html2md.js (#411)

adobe · Feb 12, 2024 · dee0154 · dee0154
1 parent aa6a497
commit dee0154
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/src/html2md.js b/src/html2md.js
@@ -21,6 +21,7 @@ import gfm from 'remark-gfm';
 import {
   imageReferences,
   sanitizeTextAndFormats,
+  sanitizeHeading,
 } from '@adobe/helix-markdown-support';
 import { remarkMatter } from '@adobe/helix-markdown-support/matter';
 import remarkGridTable from '@adobe/remark-gridtables';
@@ -263,6 +264,7 @@ export async function html2md(html, opts) {
 
   await processImages(log, mdast, mediaHandler, url);
   imageReferences(mdast);
+  sanitizeHeading(mdast);
   sanitizeTextAndFormats(mdast);
 
   // noinspection JSVoidFunctionReturnValueUsed

diff --git a/test/fixtures/breaks-in-headings.html b/test/fixtures/breaks-in-headings.html
@@ -0,0 +1,12 @@
+<html>
+<head>
+    <title>Breaks in Headings</title>
+</head>
+<body>
+<main>
+    <div>
+        <h1>Break<br>in<br>Heading</h1>
+    </div>
+</main>
+</body>
+</html>
diff --git a/test/fixtures/breaks-in-headings.md b/test/fixtures/breaks-in-headings.md
@@ -0,0 +1,7 @@
+# Break<br>in<br>Heading
+
++----------------------------+
+| Metadata                   |
++=======+====================+
+| title | Breaks in Headings |
++-------+--------------------+
diff --git a/test/html2md.test.js b/test/html2md.test.js
@@ -79,6 +79,10 @@ describe('html2md Tests', () => {
   it('convert a document with underling, sub-, and superscript', async () => {
     await test('sub-sup-u');
   });
+
+  it('convert a document with headline and soft breaks correctly', async () => {
+    await test('breaks-in-headings');
+  });
 });
 
 describe('className to block type tests', () => {