Changing OfficeYamlDocumenter to deal with code, bold, and italic markdown

AlexJerabek · AlexJerabek · commit 7b0aaca6ebdf · 2018-06-22T12:15:10.000-07:00
diff --git a/apps/api-documenter/src/yaml/OfficeYamlDocumenter.ts b/apps/api-documenter/src/yaml/OfficeYamlDocumenter.ts
@@ -88,9 +88,21 @@ export class OfficeYamlDocumenter extends YamlDocumenter {
 
     if (yamlItem.summary) {
       yamlItem.summary = this._fixupApiSet(yamlItem.summary, yamlItem.uid);
+      yamlItem.summary = this._fixBoldAndItalics(yamlItem.summary);
+      yamlItem.summary = this._fixCodeTicks(yamlItem.summary);
     }
     if (yamlItem.remarks) {
       yamlItem.remarks = this._fixupApiSet(yamlItem.remarks, yamlItem.uid);
+      yamlItem.remarks = this._fixBoldAndItalics(yamlItem.remarks);
+      yamlItem.remarks = this._fixCodeTicks(yamlItem.remarks);
+    }
+    if (yamlItem.syntax && yamlItem.syntax.parameters) {
+      yamlItem.syntax.parameters.forEach(part => {
+          if (part.description) {
+            part.description = this._fixCodeTicks(part.description);
+            part.description = this._fixBoldAndItalics(part.description);
+          }
+      });
     }
   }
 
@@ -115,4 +127,19 @@ export class OfficeYamlDocumenter extends YamlDocumenter {
     return this._apiSetUrlDefault; // match not found.
   }
 
-}
+  private _fixBoldAndItalics(text: string): string {
+    while (text.indexOf('\\*') >= 0) {
+      text = text.replace('\\*', '*');
+    }
+
+    return text;
+  }
+
+  private _fixCodeTicks(text: string): string {
+    while (text.indexOf('\\`') >= 0) {
+      text = text.replace('\\`', '`');
+    }
+
+    return text;
+  }
+}
