Update the MarkdownRenderer to support HTML tags

pgonzal · pgonzal · commit 5e1a24434b38 · 2018-06-22T03:58:20.000-07:00
diff --git a/apps/api-documenter/src/utils/MarkdownRenderer.ts b/apps/api-documenter/src/utils/MarkdownRenderer.ts
@@ -197,6 +197,7 @@ export class MarkdownRenderer {
                 case '\n':
                 case ' ':
                 case '[':
+                case '>':
                   // okay to put a symbol
                   break;
                 default:
@@ -227,6 +228,10 @@ export class MarkdownRenderer {
             writer.write(parts[3]);  // write trailing whitespace
           }
           break;
+        case 'html-tag':
+          // write the HTML element verbatim into the output
+          writer.write(element.token);
+          break;
         case 'code':
           writer.write('`');
           if (context.insideTable) {
diff --git a/apps/api-documenter/src/utils/test/ExpectedOutput.md b/apps/api-documenter/src/utils/test/ExpectedOutput.md
@@ -38,3 +38,4 @@ HTML escape: &amp;quot;
 
 3 or more hyphens: - -- \-\-\- \-\-\-- \-\-\--- \-\-\-\-\-\-
 
+<b>bold</b>
diff --git a/apps/api-documenter/src/utils/test/MarkdownRenderer.test.ts b/apps/api-documenter/src/utils/test/MarkdownRenderer.test.ts
@@ -59,6 +59,12 @@ describe('MarkdownPageRenderer', () => {
     markupPage.elements.push(...Markup.createTextParagraphs(
       '3 or more hyphens: - -- --- ---- ----- ------\n\n'));
 
+    markupPage.elements.push(...[
+      Markup.createHtmlTag('<b>'),
+      ...Markup.createTextElements('bold'),
+      Markup.createHtmlTag('</b>')
+    ]);
+
     const outputFilename: string = path.join(outputFolder, 'ActualOutput.md');
     fsx.writeFileSync(outputFilename, MarkdownRenderer.renderElements([markupPage], { }));
 
diff --git a/build-tests/api-extractor-test-05/etc/api-extractor-test-05.api.json b/build-tests/api-extractor-test-05/etc/api-extractor-test-05.api.json
@@ -107,7 +107,71 @@
           "remarks": [
             {
               "kind": "text",
-              "text": "<table> <tr> <td>John</td> <td>Doe</td> </tr> </table>"
+              "text": ""
+            },
+            {
+              "kind": "html-tag",
+              "token": "<table>"
+            },
+            {
+              "kind": "text",
+              "text": " "
+            },
+            {
+              "kind": "html-tag",
+              "token": "<tr>"
+            },
+            {
+              "kind": "text",
+              "text": " "
+            },
+            {
+              "kind": "html-tag",
+              "token": "<td>"
+            },
+            {
+              "kind": "text",
+              "text": "John"
+            },
+            {
+              "kind": "html-tag",
+              "token": "</td>"
+            },
+            {
+              "kind": "text",
+              "text": " "
+            },
+            {
+              "kind": "html-tag",
+              "token": "<td>"
+            },
+            {
+              "kind": "text",
+              "text": "Doe"
+            },
+            {
+              "kind": "html-tag",
+              "token": "</td>"
+            },
+            {
+              "kind": "text",
+              "text": " "
+            },
+            {
+              "kind": "html-tag",
+              "token": "</tr>"
+            },
+            {
+              "kind": "text",
+              "text": " "
+            },
+            {
+              "kind": "html-tag",
+              "token": "</table>"
+            },
+            {
+              "kind": "text",
+              "text": ""
             }
           ],
           "isBeta": false,
diff --git a/build-tests/api-extractor-test-05/etc/markdown/api-extractor-test-05.docclass1.tableexample.md b/build-tests/api-extractor-test-05/etc/markdown/api-extractor-test-05.docclass1.tableexample.md
@@ -12,4 +12,4 @@ tableExample(): void;
 
 ## Remarks
 
-&lt;table&gt; &lt;tr&gt; &lt;td&gt;John&lt;/td&gt; &lt;td&gt;Doe&lt;/td&gt; &lt;/tr&gt; &lt;/table&gt;
+<table> <tr> <td>John</td> <td>Doe</td> </tr> </table>
diff --git a/build-tests/api-extractor-test-05/etc/yaml/api-extractor-test-05/docclass1.yml b/build-tests/api-extractor-test-05/etc/yaml/api-extractor-test-05/docclass1.yml
@@ -36,7 +36,7 @@ items:
             - string
   - uid: api-extractor-test-05.DocClass1.tableExample
     summary: 'An example with tables:'
-    remarks: '&lt;table&gt; &lt;tr&gt; &lt;td&gt;John&lt;/td&gt; &lt;td&gt;Doe&lt;/td&gt; &lt;/tr&gt; &lt;/table&gt;'
+    remarks: <table> <tr> <td>John</td> <td>Doe</td> </tr> </table>
     name: tableExample()
     fullName: api-extractor-test-05.DocClass1.tableExample
     langs:

Original file line number	Diff line number	Diff line change
`@@ -38,3 +38,4 @@ HTML escape: &quot;`
`38`	`38`
`39`	`39`	`3 or more hyphens: - -- \-\-\- \-\-\-- \-\-\--- \-\-\-\-\-\-`
`40`	`40`
	`41`	`+<b>bold</b>`
Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,4 @@ tableExample(): void;`
`12`	`12`
`13`	`13`	`## Remarks`
`14`	`14`
`15`		`-<table> <tr> <td>John</td> <td>Doe</td> </tr> </table>`
	`15`	`+<table> <tr> <td>John</td> <td>Doe</td> </tr> </table>`