docs: upgrade docs generation

Author: posva

package.json

@@ -36,7 +36,7 @@
     "@rollup/plugin-replace": "^6.0.1",
     "@rollup/plugin-terser": "^0.4.4",
     "@types/lodash.kebabcase": "^4.1.9",
-    "@types/node": "^20.14.12",
+    "@types/node": "^22.10.1",
     "@vitest/coverage-v8": "^2.1.8",
     "@vitest/ui": "^2.1.8",
     "@vue/compiler-sfc": "~3.5.13",
@@ -58,7 +58,7 @@
     "semver": "^7.6.3",
     "simple-git-hooks": "^2.11.1",
     "typedoc": "^0.26.11",
-    "typedoc-plugin-markdown": "^4.2.10",
+    "typedoc-plugin-markdown": "~4.2.0",
     "typescript": "~5.6.3",
     "vitest": "^2.1.8",
     "vue": "~3.5.13"

packages/docs/.vitepress/config/en.ts

@@ -1,4 +1,5 @@
 import type { DefaultTheme, LocaleSpecificConfig } from 'vitepress'
+import typedocSidebar from '../../api/typedoc-sidebar.json'
 
 export const META_URL = 'https://pinia.vuejs.org'
 export const META_TITLE = 'Pinia 🍍'
@@ -53,18 +54,8 @@ export const enConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
     sidebar: {
       '/api/': [
         {
-          text: 'packages',
-          items: [
-            { text: 'pinia', link: '/api/pinia/' },
-            {
-              text: '@pinia/nuxt',
-              link: '/api/@pinia/nuxt/',
-            },
-            {
-              text: '@pinia/testing',
-              link: '/api/@pinia/testing/',
-            },
-          ],
+          text: 'API',
+          items: typedocSidebar,
         },
       ],
       // catch-all fallback

packages/docs/package.json

@@ -4,6 +4,7 @@
   "private": true,
   "type": "module",
   "scripts": {
+    "predocs": "node run-typedoc.mjs",
     "docs": "vitepress dev .",
     "docs:api": "node run-typedoc.mjs",
     "docs:translation:compare": "v-translation compare",
@@ -17,6 +18,7 @@
     "@vueuse/core": "^12.0.0",
     "pinia": "workspace:*",
     "vitepress": "1.5.0",
+    "typedoc-vitepress-theme": "^1.1.1",
     "vitepress-translation-helper": "^0.2.2",
     "vue-use-spring": "^0.3.3"
   }

packages/docs/run-typedoc.mjs

@@ -4,13 +4,19 @@ import { createTypeDocApp } from './typedoc-markdown.mjs'
 const __dirname = path.dirname(new URL(import.meta.url).pathname)
 
 createTypeDocApp({
-  name: 'API Documentation',
+  textContentMappings: {
+    'title.indexPage': 'API Reference',
+    'title.memberPage': '{name}',
+  },
   tsconfig: path.resolve(__dirname, './typedoc.tsconfig.json'),
   // entryPointStrategy: 'packages',
   categorizeByGroup: true,
   githubPages: false,
+  readme: 'none',
+  indexFormat: 'table',
   disableSources: true,
-  plugin: ['typedoc-plugin-markdown'],
+  plugin: ['typedoc-plugin-markdown', 'typedoc-vitepress-theme'],
+  useCodeBlocks: true,
   entryPoints: [
     path.resolve(__dirname, '../pinia/src/index.ts'),
     path.resolve(__dirname, '../testing/src/index.ts'),

packages/docs/typedoc-markdown.mjs

@@ -5,15 +5,13 @@ import { Application, TSConfigReader, PageEvent } from 'typedoc'
 
 const __dirname = path.dirname(new URL(import.meta.url).pathname)
 
+/** @satisfies {Partial<import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions>} */
 const DEFAULT_OPTIONS = {
-  // disableOutputCheck: true,
   cleanOutputDir: true,
   excludeInternal: true,
-  readme: 'none',
   out: path.resolve(__dirname, './api'),
   entryFileName: 'index.md',
-  hideBreadcrumbs: false,
-  // hideInPageTOC: true,
+  // hideBreadcrumbs: false,
   preserveAnchorCasing: true,
 }
 

packages/pinia/package.json

@@ -69,7 +69,7 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@microsoft/api-extractor": "7.47.11",
+    "@microsoft/api-extractor": "7.48.0",
     "@vue/test-utils": "^2.4.6"
   },
   "dependencies": {