wrap body summaries in markdown

PaloAltoNetworks · Nov 21, 2024 · 8465687 · 8465687
1 parent 79f56e7
commit 8465687
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/Body/index.tsx
@@ -14,6 +14,7 @@ import FormSelect from "@theme/ApiExplorer/FormSelect";
 import FormTextInput from "@theme/ApiExplorer/FormTextInput";
 import LiveApp from "@theme/ApiExplorer/LiveEditor";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
+import Markdown from "@theme/Markdown";
 import SchemaTabs from "@theme/SchemaTabs";
 import TabItem from "@theme/TabItem";
 import { RequestBodyObject } from "docusaurus-plugin-openapi-docs/src/openapi/types";
@@ -303,7 +304,7 @@ function Body({
           </TabItem>
           {/* @ts-ignore */}
           <TabItem label="Example" value="example">
-            {example.summary && <div>{example.summary}</div>}
+            {example.summary && <Markdown>{example.summary}</Markdown>}
             {exampleBody && (
               <LiveApp
                 action={dispatch}
@@ -341,7 +342,7 @@ function Body({
                 value={example.label}
                 key={example.label}
               >
-                {example.summary && <div>{example.summary}</div>}
+                {example.summary && <Markdown>{example.summary}</Markdown>}
                 {example.body && (
                   <LiveApp action={dispatch} language={language}>
                     {example.body}