Update typedoc to 0.28.14 and typedoc-plugin-markdown to 4.9.0

e2e/fixtures/plugin-typedoc/index.test.ts

@@ -33,8 +33,8 @@ test.describe('plugin-typedoc single entry', async () => {
         'Functions',
         'Function: createMiddleware',
         'Function: mergeMiddlewares',
-        'Types',
-        'Type alias: Middleware',
+        'Type-aliases',
+        'Type Alias: Middleware()',
       ].join(','),
     );
   });
@@ -63,26 +63,20 @@ test.describe('plugin-typedoc multi entries', async () => {
     await expect(navItems).toHaveCount(2);
 
     const sidebarTexts = await getSidebarTexts(page);
-    expect(sidebarTexts.length).toBe(10);
+    expect(sidebarTexts.length).toBe(7);
     expect(sidebarTexts.join(',')).toEqual(
       [
         '@rspress-fixture/rspress-plugin-typedoc-multi',
-        'Functions',
-        'Function: createMiddleware',
-        'Function: mergeMiddlewares',
-        'Function: getRspressUrl',
-        'Modules',
-        'Module: middleware',
-        'Module: raw-link',
-        'Types',
-        'Type alias: Middleware',
+        'Index',
+        'Middleware',
+        'Raw-link',
       ].join(','),
     );
   });
 
   test('Should render raw link correctly', async ({ page }) => {
     await page.goto(
-      `http://localhost:${appPort}/api/functions/raw_link.getRspressUrl.html`,
+      `http://localhost:${appPort}/api/raw-link/functions/getRspressUrl.html`,
       {
         waitUntil: 'networkidle',
       },

packages/plugin-typedoc/package.json

@@ -33,8 +33,8 @@
     "reset": "rimraf ./**/node_modules"
   },
   "dependencies": {
-    "typedoc": "0.24.8",
-    "typedoc-plugin-markdown": "3.17.1"
+    "typedoc": "0.28.14",
+    "typedoc-plugin-markdown": "4.9.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.53.3",

packages/plugin-typedoc/src/index.ts

@@ -24,30 +24,32 @@ export function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {
   return {
     name: '@rspress/plugin-typedoc',
     async config(config) {
-      const app = new Application();
       docRoot = config.root;
-      app.options.addReader(new TSConfigReader());
+      const app = await Application.bootstrap(
+        {
+          name: config.title,
+          entryPoints,
+          disableSources: true,
+          readme: 'none',
+          githubPages: false,
+          requiredToBeDocumented: ['Class', 'Function', 'Interface'],
+        },
+        [new TSConfigReader()],
+      );
+      // Load the markdown plugin manually
       load(app);
-      app.bootstrap({
-        name: config.title,
-        entryPoints,
-        theme: 'markdown',
-        disableSources: true,
-        readme: 'none',
-        githubPages: false,
-        requiredToBeDocumented: ['Class', 'Function', 'Interface'],
-        plugin: ['typedoc-plugin-markdown'],
-        // @ts-expect-error - FIXME: current version of MarkdownTheme has no export, bump related package versions
-        hideBreadcrumbs: true,
-        hideMembersSymbol: true,
-        allReflectionsHaveOwnDocument: true,
-      });
-      const project = app.convert();
+      // Set plugin-specific options after loading the plugin
+      app.options.setValue('hideBreadcrumbs', true);
+      app.options.setValue('fileExtension', '.md');
+      app.options.setValue('entryFileName', 'index');
+      const project = await app.convert();
 
       if (project) {
         // 1. Generate doc/api, doc/api/_meta.json by typedoc
         const absoluteApiDir = path.join(docRoot!, outDir);
-        await app.generateDocs(project, absoluteApiDir);
+        // Set the markdown output directory and generate outputs
+        app.options.setValue('markdown', absoluteApiDir);
+        await app.generateOutputs(project);
         await patchGeneratedApiDocs(absoluteApiDir);
       }
       return config;

packages/plugin-typedoc/src/patch.ts

@@ -70,9 +70,16 @@ async function generateMetaJson(absoluteApiDir: string) {
 
 export async function patchGeneratedApiDocs(absoluteApiDir: string) {
   await patchLinks(absoluteApiDir);
-  await fs.rename(
-    path.join(absoluteApiDir, 'README.md'),
-    path.join(absoluteApiDir, 'index.md'),
-  );
+  // In newer versions of typedoc-plugin-markdown with entryFileName='index',
+  // index.md is generated directly. Only rename if README.md exists.
+  const readmePath = path.join(absoluteApiDir, 'README.md');
+  const indexPath = path.join(absoluteApiDir, 'index.md');
+  try {
+    await fs.access(readmePath);
+    // README.md exists, rename it to index.md
+    await fs.rename(readmePath, indexPath);
+  } catch {
+    // README.md doesn't exist, index.md should already exist
+  }
   await generateMetaJson(absoluteApiDir);
 }