fix 'platform-specific' heading on js api (#3413)

Author: vasfvitor

packages/js-api-generator/build.ts

@@ -169,6 +169,8 @@ function pageEventEnd(event: PageEvent<DeclarationReflection>) {
 class TauriThemeRenderContext extends MarkdownThemeContext {
   constructor(theme: MarkdownTheme, page: MarkdownPageEvent<Reflection>, options: Options) {
     super(theme, page, options);
+    const originalCommentPartial = this.partials.comment;
+
     this.partials = {
       ...this.partials,
       // Formats `@source` to be a single line
@@ -180,6 +182,37 @@ class TauriThemeRenderContext extends MarkdownThemeContext {
         const sources = model.sources.map((source) => `${source.url}`);
         return label + sources.join(', ');
       },
+      // Remove heading markers from JSDoc comments to prevent accidental markdown headings
+      comment: function (comment, options) {
+        const headingStringsToReplace = [
+          // known to break
+          '#### Platform-specific',
+          // just to be sure
+          '### Platform-specific',
+        ];
+
+        if (comment?.summary) {
+          comment.summary.forEach((line) => {
+            if (line.kind === 'text' && typeof line.text === 'string') {
+              headingStringsToReplace.forEach((headingString) => {
+                line.text = line.text.replace(headingString, headingString.replace(/^#+\s*/, ''));
+              });
+            }
+          });
+        }
+        if (comment?.blockTags) {
+          comment.blockTags.forEach((tag) => {
+            tag.content.forEach((line) => {
+              if (line.kind === 'text' && typeof line.text === 'string') {
+                headingStringsToReplace.forEach((headingString) => {
+                  line.text = line.text.replace(headingString, headingString.replace(/^#+\s*/, ''));
+                });
+              }
+            });
+          });
+        }
+        return originalCommentPartial.call(this, comment, options);
+      },
     };
   }
 

packages/js-api-generator/package.json

@@ -15,6 +15,7 @@
     "tsm": "^2.3.0",
     "typedoc": "0.26.6",
     "typedoc-plugin-markdown": "4.2.6",
-    "typedoc-plugin-mdn-links": "3.2.11"
+    "typedoc-plugin-mdn-links": "3.2.11",
+    "typescript": "5.5"
   }
 }