Merge branch 'main' into issue-272-memory

Author: seratch

docs/astro.config.mjs

@@ -23,7 +23,11 @@ const typeDocConfig = {
   parametersFormat: 'htmlTable',
   propertyMembersFormat: 'htmlTable',
   disableSources: true,
-  plugin: ['typedoc-plugin-zod'],
+  plugin: [
+    'typedoc-plugin-zod',
+    'typedoc-plugin-frontmatter',
+    './src/plugins/typedoc-frontmatter.js',
+  ],
 };
 
 const plugins = [

docs/package.json

@@ -25,6 +25,7 @@
   "devDependencies": {
     "tailwindcss": "^3.3.3",
     "tsx": "^4.19.4",
+    "typedoc-plugin-frontmatter": "^1.3.0",
     "typedoc-plugin-zod": "^1.4.1"
   }
 }

docs/src/plugins/typedoc-frontmatter.js

@@ -0,0 +1,16 @@
+import { MarkdownPageEvent } from 'typedoc-plugin-markdown';
+
+/** @param {import('typedoc-plugin-markdown').MarkdownApplication} app */
+export function load(app) {
+  app.renderer.on(MarkdownPageEvent.BEGIN, (page) => {
+    // page.frontmatter が undefined の場合でも確実に title を入れる
+    page.frontmatter = {
+      ...page.frontmatter,
+      title:
+        page.frontmatter?.title ||
+        page.title ||
+        page.url?.split('/').pop() ||
+        undefined,
+    };
+  });
+}