Merge pull request #164 from docsbydoxdox/hotfix/bootstrap-markdown-types

neogeek · web-flow · commit 09f502896b84 · 2022-03-23T01:47:07.000-04:00
[hotfix] Render types with markdown renderer.
diff --git a/packages/doxdox-renderer-bootstrap/src/index.ts b/packages/doxdox-renderer-bootstrap/src/index.ts
@@ -15,6 +15,8 @@ const md = new MarkdownIt({
         }</div>`
 });
 
+const mdTypes = new MarkdownIt();
+
 const renderMethod = (method: Method) => `<div class="mb-5" data-method-name="${
     method.name
 }"><a name="${method.slug}" />
@@ -36,14 +38,19 @@ ${
 <div class="table-responsive">
 ${md
     .render(
-        markdownTable([
-            ['Name', 'Types', 'Description'],
-            ...method.params.map(({ name, types, description }) => [
-                name,
-                `<code>${types.join('</code>, <code>')}</code>`,
-                description || ''
-            ])
-        ])
+        markdownTable(
+            [
+                ['Name', 'Types', 'Description'],
+                ...method.params.map(({ name, types, description }) => [
+                    name,
+                    `<code>${types
+                        .map(type => mdTypes.renderInline(type))
+                        .join('</code>, <code>')}</code>`,
+                    description || ''
+                ])
+            ],
+            {}
+        )
     )
     .replace('<table>', '<table class="table">')}
 </div>`
@@ -55,7 +62,9 @@ ${
         ? `<h3>Returns</h3>
 
 ${method.returns.map(
-    param => `<p><code>${param.types.join('</code>, <code>')}</code></p>
+    param => `<p><code>${param.types
+        .map(type => mdTypes.renderInline(type))
+        .join('</code>, <code>')}</code></p>
 
 ${param.description ? `<p>${param.description}</p>` : ''}`
 )}`
diff --git a/packages/doxdox-renderer-dash/src/index.ts b/packages/doxdox-renderer-dash/src/index.ts
@@ -25,6 +25,8 @@ const md = new MarkdownIt({
         }</div>`
 });
 
+const mdTypes = new MarkdownIt();
+
 const renderMethod = (doc: Doc, method: Method) => `<!DOCTYPE html>
 <html>
 <head>
@@ -63,7 +65,9 @@ ${md
             ['Name', 'Types', 'Description'],
             ...method.params.map(({ name, types, description }) => [
                 name,
-                `<code>${types.join('</code>, <code>')}</code>`,
+                `<code>${types
+                    .map(type => mdTypes.renderInline(type))
+                    .join('</code>, <code>')}</code>`,
                 description || ''
             ])
         ])
@@ -78,7 +82,9 @@ ${
         ? `<h3>Returns</h3>
 
 ${method.returns.map(
-    param => `<p><code>${param.types.join('</code>, <code>')}</code></p>
+    param => `<p><code>${param.types
+        .map(type => mdTypes.renderInline(type))
+        .join('</code>, <code>')}</code></p>
 
 ${param.description ? `<p>${param.description}</p>` : ''}`
 )}`
diff --git a/packages/doxdox-renderer-pdf/src/index.ts b/packages/doxdox-renderer-pdf/src/index.ts
@@ -17,6 +17,8 @@ const md = new MarkdownIt({
         }</div>`
 });
 
+const mdTypes = new MarkdownIt();
+
 const renderMethod = (method: Method) => `<div class="mb-5"><a name="${
     method.slug
 }" />
@@ -37,7 +39,9 @@ ${md
             ['Name', 'Types', 'Description'],
             ...method.params.map(({ name, types, description }) => [
                 name,
-                `<code>${types.join('</code>, <code>')}</code>`,
+                `<code>${types
+                    .map(type => mdTypes.renderInline(type))
+                    .join('</code>, <code>')}</code>`,
                 description || ''
             ])
         ])
@@ -52,7 +56,9 @@ ${
         ? `<h3>Returns</h3>
 
 ${method.returns.map(
-    param => `<p><code>${param.types.join('</code>, <code>')}</code></p>
+    param => `<p><code>${param.types
+        .map(type => mdTypes.renderInline(type))
+        .join('</code>, <code>')}</code></p>
 
 ${param.description ? `<p>${param.description}</p>` : ''}`
 )}`
