fix(api-docgen): allow multiple lines description (web-infra-dev#863)

.changeset/pink-knives-compare.md

@@ -0,0 +1,5 @@
+---
+"@rspress/plugin-api-docgen": patch
+---
+
+fix(api-docgen): allow multiple lines description

e2e/fixtures/api-docgen/src/Button.ts

@@ -1,6 +1,8 @@
 export type ButtonProps = {
   /**
    * Whether to disable the button
+   * - This is extra line a
+   * - This is extra line b
    */
   disabled?: boolean;
   /**

e2e/tests/api-docgen.test.ts

@@ -33,6 +33,8 @@ test.describe('api-docgen test', async () => {
     // Description
     expect(tableContent).toContain('Description');
     expect(tableContent).toContain('Whether to disable the button');
+    expect(tableContent).toContain('- This is extra line a');
+    expect(tableContent).toContain('- This is extra line b');
     expect(tableContent).toContain('Type of Button');
 
     // Type

packages/plugin-api-docgen/src/docgen.ts

@@ -196,7 +196,12 @@ function generateTable(componentDoc: ComponentDoc[], language: 'zh' | 'en') {
                 return description;
             }
           };
-          return `|${[name, getDescription(), getType(), getDefaultValue()]
+
+          const formattedDescription = getDescription()
+            // allow newline
+            .replace(/\n/g, '
');
+
+          return `|${[name, formattedDescription, getType(), getDefaultValue()]
             .map(str => str.replace(/(?<!\\)\|/g, '&#124;'))
             .join('|')}|`;
         });

packages/plugin-api-docgen/static/global-components/API.scss

@@ -1,4 +1,9 @@
 table {
   table-layout: fixed;
   width: 100%;
+
+  td {
+    // allow use 
 to break line
+    white-space: pre-wrap;
+  }
 }