docs(markdown): parse :::note's text as MD elements

microsoft · Sep 11, 2024 · 0d97fc4 · 0d97fc4
1 parent aaac57b
commit 0d97fc4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/utils/doclint/documentation.js b/utils/doclint/documentation.js
@@ -802,12 +802,12 @@ function generateSourceCodeComment(spec) {
       node.codeLang = parseCodeLang(node.codeLang).highlighter;
     if (node.type === 'note') {
       // @ts-ignore
-      node.type = 'text';
-      node.text = '**NOTE** ' + node.text;
+      node.type = 'text'
+      node.text = `**NOTE** ` + (node.children || []).map(child => md.render([child], { flattenText: false, omitLastCR: true })).join('↵')
     }
   });
   // 5 is a typical member doc offset.
-  return md.render(comments, { maxColumns: 120 - 5, omitLastCR: true, flattenText: true });
+  return md.render(comments,  { maxColumns: 120 - 5, omitLastCR: true, flattenText: true });
 }
 
 /**

diff --git a/utils/markdown.js b/utils/markdown.js
@@ -50,7 +50,6 @@
 
 /** @typedef {MarkdownBaseNode & {
  *    type: 'note',
- *    text: string,
  *    noteType: string,
  *  }} MarkdownNoteNode */
 
@@ -208,7 +207,7 @@ function buildTree(lines) {
         tokens.push(line.substring(indent.length));
         line = lines[++i];
       }
-      node.text = tokens.join('↵');
+      node.children = buildTree(tokens);
       appendNode(indent, node);
       continue;
     }
@@ -341,7 +340,9 @@ function innerRenderMdNode(indent, node, lastNode, result, options) {
   if (node.type === 'note') {
     newLine();
     result.push(`${indent}:::${node.noteType}`);
-    result.push(wrapText(node.text, options, indent));
+    const children = node.children || [];
+    for (const child of children)
+      innerRenderMdNode(indent, child, children[children.length - 1], result, options);
     result.push(`${indent}:::`);
     newLine();
     return;