mn-docs-mcp 0.6.2 → 1.1.0

package/.trae/documents/libmn_cleanup_plan.md

@@ -0,0 +1,51 @@
+# LibMN文档清理计划
+
+## [x] 任务1: 移除所有文档中的示例、常见错误、参考部分
+- **优先级**: P0
+- **依赖**: 无
+- **描述**:
+  - 遍历所有libmn文档文件
+  - 移除每个方法中的示例、常见错误、参考部分
+  - 保持其他结构不变
+- **成功标准**:
+  - 所有文档中不再包含示例、常见错误、参考部分
+- **测试要求**:
+  - `programmatic` TR-1.1: 检查每个文档文件，确认示例、常见错误、参考部分已被移除
+  - `human-judgement` TR-1.2: 确认文档结构清晰，只包含类型、说明、参数、返回值
+
+## [x] 任务2: 修复表格中类型包含竖线的问题
+- **优先级**: P0
+- **依赖**: 无
+- **描述**:
+  - 检查所有文档中的表格
+  - 修复类型字段中包含竖线的问题，使用适当的转义或替代方案
+- **成功标准**:
+  - 所有表格中的类型字段不再包含会被解析为表格线的竖线
+- **测试要求**:
+  - `programmatic` TR-2.1: 检查所有表格，确认类型字段中的竖线已被正确处理
+  - `human-judgement` TR-2.2: 确认表格显示正常，无解析错误
+
+## [x] 任务3: 检查并修改未按照要求修改的文档
+- **优先级**: P1
+- **依赖**: 任务1, 任务2
+- **描述**:
+  - 检查MNButton等未按照要求修改的文档
+  - 按照Headers文档的标准结构进行修改
+  - 确保字段使用表格格式，方法使用Headers风格
+- **成功标准**:
+  - 所有文档都按照Headers文档的标准结构进行了修改
+- **测试要求**:
+  - `programmatic` TR-3.1: 检查所有文档，确认结构符合标准
+  - `human-judgement` TR-3.2: 确认文档结构一致，符合要求
+
+## [x] 任务4: 验证所有修改
+- **优先级**: P2
+- **依赖**: 任务1, 任务2, 任务3
+- **描述**:
+  - 验证所有文档的修改是否符合要求
+  - 检查是否有遗漏的部分
+- **成功标准**:
+  - 所有文档都符合要求，无遗漏
+- **测试要求**:
+  - `programmatic` TR-4.1: 检查所有文档，确认所有修改都已完成
+  - `human-judgement` TR-4.2: 确认文档整体质量良好

package/.trae/documents/libmn_doc_restructure_plan.md

@@ -0,0 +1,140 @@
+# LibMN文档结构重整理计划
+
+## 项目背景
+根据用户要求，需要将LibMN文档按照Headers文档的结构进行统一整理，确保所有文档都包含类型、说明、参数、返回值，且字段和方法分开展示。
+
+## 整理标准
+- **字段**：使用表格形式列出，包含成员、类型、说明
+- **方法**：按照Headers文档的格式组织，包含类型、说明、参数、返回值
+- **说明文本**：补充所有方法和字段的说明文本，介绍功能和作用
+- **格式统一**：确保所有文档都按照统一的格式组织
+
+## 任务列表
+
+### [/] 任务1：整理MNUtil文档
+- **优先级**：P0
+- **依赖**：无
+- **描述**：
+  - 将MNUtil文档的字段和方法分开
+  - 字段使用表格形式展示
+  - 方法按照Headers文档的格式组织
+  - 补充说明文本
+- **成功标准**：
+  - 文档结构符合Headers文档的格式
+  - 字段和方法分开展示
+  - 包含类型、说明、参数、返回值
+- **测试要求**：
+  - `programmatic` TR-1.1：文档结构符合Headers文档格式
+  - `human-judgement` TR-1.2：内容完整，说明清晰
+- **注意**：MNUtil成员较多，需要耐心整理
+
+### [ ] 任务2：整理MNNote文档
+- **优先级**：P0
+- **依赖**：任务1
+- **描述**：
+  - 将MNNote文档的字段和方法分开
+  - 字段使用表格形式展示
+  - 方法按照Headers文档的格式组织
+  - 补充说明文本
+- **成功标准**：
+  - 文档结构符合Headers文档的格式
+  - 字段和方法分开展示
+  - 包含类型、说明、参数、返回值
+- **测试要求**：
+  - `programmatic` TR-2.1：文档结构符合Headers文档格式
+  - `human-judgement` TR-2.2：内容完整，说明清晰
+- **注意**：MNNote有100个成员，工作量较大
+
+### [ ] 任务3：整理MNDocument文档
+- **优先级**：P1
+- **依赖**：任务2
+- **描述**：
+  - 保留字段的表格形式
+  - 将方法部分按照Headers文档的格式组织
+  - 补充说明文本
+- **成功标准**：
+  - 文档结构符合Headers文档的格式
+  - 字段和方法分开展示
+  - 包含类型、说明、参数、返回值
+- **测试要求**：
+  - `programmatic` TR-3.1：文档结构符合Headers文档格式
+  - `human-judgement` TR-3.2：内容完整，说明清晰
+- **注意**：MNDocument的字段部分已经符合要求，只需要整理方法部分
+
+### [ ] 任务4：整理MNWebview文档
+- **优先级**：P1
+- **依赖**：任务3
+- **描述**：
+  - 完善方法部分的结构，确保符合Headers文档的格式
+  - 补充说明文本
+- **成功标准**：
+  - 文档结构符合Headers文档的格式
+  - 包含类型、说明、参数、返回值
+- **测试要求**：
+  - `programmatic` TR-4.1：文档结构符合Headers文档格式
+  - `human-judgement` TR-4.2：内容完整，说明清晰
+- **注意**：MNWebview的方法部分已经有类似结构，需要进一步完善
+
+### [ ] 任务5：整理Runtime文档
+- **优先级**：P1
+- **依赖**：任务4
+- **描述**：
+  - 完善字段和方法部分的结构，确保符合Headers文档的格式
+  - 补充说明文本
+- **成功标准**：
+  - 文档结构符合Headers文档的格式
+  - 包含类型、说明、参数、返回值
+- **测试要求**：
+  - `programmatic` TR-5.1：文档结构符合Headers文档格式
+  - `human-judgement` TR-5.2：内容完整，说明清晰
+- **注意**：Runtime的结构已经比较接近要求，需要进一步完善
+
+### [ ] 任务6：整理Response文档
+- **优先级**：P1
+- **依赖**：任务5
+- **描述**：
+  - 完善字段和方法部分的结构，确保符合Headers文档的格式
+  - 补充说明文本
+- **成功标准**：
+  - 文档结构符合Headers文档的格式
+  - 包含类型、说明、参数、返回值
+- **测试要求**：
+  - `programmatic` TR-6.1：文档结构符合Headers文档格式
+  - `human-judgement` TR-6.2：内容完整，说明清晰
+- **注意**：Response的结构已经比较接近要求，需要进一步完善
+
+### [ ] 任务7：汇总不确定内容清单
+- **优先级**：P2
+- **依赖**：所有任务
+- **描述**：
+  - 收集整理过程中遇到的不确定内容
+  - 列出清单供用户补充
+- **成功标准**：
+  - 所有不确定内容都已记录
+  - 清单格式清晰，便于用户理解
+- **测试要求**：
+  - `human-judgement` TR-7.1：清单完整，描述清晰
+- **注意**：确保所有不确定内容都有明确的标记
+
+## 实施顺序
+1. 任务1：整理MNUtil文档
+2. 任务2：整理MNNote文档
+3. 任务3：整理MNDocument文档
+4. 任务4：整理MNWebview文档
+5. 任务5：整理Runtime文档
+6. 任务6：整理Response文档
+7. 任务7：汇总不确定内容清单
+
+## 预期交付物
+- 6个整理后的LibMN文档
+- 1个不确定内容清单
+
+## 时间估计
+- 任务1：2-3小时
+- 任务2：3-4小时
+- 任务3：1-2小时
+- 任务4：1-2小时
+- 任务5：1-2小时
+- 任务6：1-2小时
+- 任务7：0.5小时
+- 总计：10-15小时

package/.trae/documents/libmn_indentation_plan.md

@@ -0,0 +1,116 @@
+# LibMN文档缩进层级修复计划
+
+## \[x] 任务1: 检查headers.md文档的缩进层级问题
+
+* **优先级**: P0
+
+* **依赖**: 无
+
+* **描述**:
+
+  * 检查headers.md文档的结构
+
+  * 确认"方法"标题与具体方法之间的缩进层级关系
+
+  * 识别具体的缩进问题
+
+* **成功标准**:
+
+  * 明确headers.md文档中的缩进层级问题
+
+* **测试要求**:
+
+  * `programmatic` TR-1.1: 检查headers.md文档的标题层级结构
+
+  * `human-judgement` TR-1.2: 确认"方法"标题与具体方法的层级关系是否正确
+
+## \[x] 任务2: 检查其他文档的缩进层级问题
+
+* **优先级**: P0
+
+* **依赖**: 任务1
+
+* **描述**:
+
+  * 检查其他libmn文档的缩进层级
+
+  * 找出与headers.md类似的缩进问题
+
+  * 记录所有有问题的文档
+
+* **成功标准**:
+
+  * 找出所有存在缩进层级问题的文档
+
+* **测试要求**:
+
+  * `programmatic` TR-2.1: 检查所有libmn文档的标题层级结构
+
+  * `human-judgement` TR-2.2: 确认所有文档中"方法"标题与具体方法的层级关系是否正确
+
+## \[x] 任务3: 修复headers.md文档的缩进层级
+
+* **优先级**: P1
+
+* **依赖**: 任务1
+
+* **描述**:
+
+  * 修复headers.md文档的缩进层级问题
+
+  * 确保"方法"标题与具体方法之间的层级关系正确
+
+* **成功标准**:
+
+  * headers.md文档的缩进层级正确
+
+* **测试要求**:
+
+  * `programmatic` TR-3.1: 检查修复后的headers.md文档结构
+
+  * `human-judgement` TR-3.2: 确认"方法"标题与具体方法的层级关系正确
+
+## [x] 任务4: 修复其他文档的缩进层级
+
+* **优先级**: P1
+
+* **依赖**: 任务2
+
+* **描述**:
+
+  * 修复所有存在缩进层级问题的文档
+
+  * 确保所有文档中"方法"标题与具体方法之间的层级关系正确
+
+* **成功标准**:
+
+  * 所有文档的缩进层级正确
+
+* **测试要求**:
+
+  * `programmatic` TR-4.1: 检查修复后的文档结构
+
+  * `human-judgement` TR-4.2: 确认所有文档中"方法"标题与具体方法的层级关系正确
+
+## [x] 任务5: 验证所有修复
+
+* **优先级**: P2
+
+* **依赖**: 任务3, 任务4
+
+* **描述**:
+
+  * 验证所有文档的缩进层级是否正确
+
+  * 确保没有遗漏的缩进问题
+
+* **成功标准**:
+
+  * 所有文档的缩进层级正确
+
+* **测试要求**:
+
+  * `programmatic` TR-5.1: 检查所有文档的标题层级结构
+
+  * `human-judgement` TR-5.2: 确认所有文档中"方法"标题与具体方法的层级关系正确
+

package/.trae/documents/libmn_title_hierarchy_plan.md

@@ -0,0 +1,91 @@
+# LibMN文档标题层级修复计划
+
+## [x] 任务1: 检查并修复headers.md文档的标题层级
+- **优先级**: P0
+- **依赖**: 无
+- **描述**:
+  - 检查headers.md文档的结构
+  - 将类型、说明、参数、返回值从四级标题改为五级标题
+  - 确保方法名与类型、说明、参数、返回值之间的层级关系正确
+- **成功标准**:
+  - headers.md文档的标题层级正确，类型、说明、参数、返回值成为方法名的下一级
+- **测试要求**:
+  - `programmatic` TR-1.1: 检查headers.md文档的标题层级结构
+  - `human-judgement` TR-1.2: 确认方法名与类型、说明、参数、返回值的层级关系正确
+
+## [x] 任务2: 检查并修复mndocument.md文档的标题层级
+- **优先级**: P0
+- **依赖**: 任务1
+- **描述**:
+  - 检查mndocument.md文档的结构
+  - 将类型、说明、参数、返回值从四级标题改为五级标题
+  - 确保方法名与类型、说明、参数、返回值之间的层级关系正确
+- **成功标准**:
+  - mndocument.md文档的标题层级正确，类型、说明、参数、返回值成为方法名的下一级
+- **测试要求**:
+  - `programmatic` TR-2.1: 检查mndocument.md文档的标题层级结构
+  - `human-judgement` TR-2.2: 确认方法名与类型、说明、参数、返回值的层级关系正确
+
+## [x] 任务3: 检查并修复mnbutton.md文档的标题层级
+- **优先级**: P0
+- **依赖**: 任务1
+- **描述**:
+  - 检查mnbutton.md文档的结构
+  - 将类型、说明、参数、返回值从四级标题改为五级标题
+  - 确保方法名与类型、说明、参数、返回值之间的层级关系正确
+- **成功标准**:
+  - mnbutton.md文档的标题层级正确，类型、说明、参数、返回值成为方法名的下一级
+- **测试要求**:
+  - `programmatic` TR-3.1: 检查mnbutton.md文档的标题层级结构
+  - `human-judgement` TR-3.2: 确认方法名与类型、说明、参数、返回值的层级关系正确
+
+## [x] 任务4: 检查并修复mnnote.md文档的标题层级
+- **优先级**: P0
+- **依赖**: 任务1
+- **描述**:
+  - 检查mnnote.md文档的结构
+  - 将类型、说明、参数、返回值从四级标题改为五级标题
+  - 确保方法名与类型、说明、参数、返回值之间的层级关系正确
+- **成功标准**:
+  - mnnote.md文档的标题层级正确，类型、说明、参数、返回值成为方法名的下一级
+- **测试要求**:
+  - `programmatic` TR-4.1: 检查mnnote.md文档的标题层级结构
+  - `human-judgement` TR-4.2: 确认方法名与类型、说明、参数、返回值的层级关系正确
+
+## [x] 任务5: 检查并修复mnutil.md文档的标题层级
+- **优先级**: P0
+- **依赖**: 任务1
+- **描述**:
+  - 检查mnutil.md文档的结构
+  - 将类型、说明、参数、返回值从四级标题改为五级标题
+  - 确保方法名与类型、说明、参数、返回值之间的层级关系正确
+- **成功标准**:
+  - mnutil.md文档的标题层级正确，类型、说明、参数、返回值成为方法名的下一级
+- **测试要求**:
+  - `programmatic` TR-5.1: 检查mnutil.md文档的标题层级结构
+  - `human-judgement` TR-5.2: 确认方法名与类型、说明、参数、返回值的层级关系正确
+
+## [/] 任务6: 检查并修复其他剩余文档的标题层级
+- **优先级**: P1
+- **依赖**: 任务1
+- **描述**:
+  - 检查其他剩余libmn文档的结构
+  - 将类型、说明、参数、返回值从四级标题改为五级标题
+  - 确保方法名与类型、说明、参数、返回值之间的层级关系正确
+- **成功标准**:
+  - 所有剩余文档的标题层级正确，类型、说明、参数、返回值成为方法名的下一级
+- **测试要求**:
+  - `programmatic` TR-6.1: 检查所有剩余文档的标题层级结构
+  - `human-judgement` TR-6.2: 确认所有剩余文档中方法名与类型、说明、参数、返回值的层级关系正确
+
+## [ ] 任务7: 验证所有文档的标题层级修复情况
+- **优先级**: P2
+- **依赖**: 任务1-6
+- **描述**:
+  - 验证所有文档的标题层级是否正确
+  - 确保类型、说明、参数、返回值都成为方法名的下一级
+- **成功标准**:
+  - 所有文档的标题层级正确
+- **测试要求**:
+  - `programmatic` TR-7.1: 检查所有文档的标题层级结构
+  - `human-judgement` TR-7.2: 确认所有文档中方法名与类型、说明、参数、返回值的层级关系正确

package/README.md

@@ -5,7 +5,7 @@
 - **在线文档**：[https://mn-docs.museday.top](https://mn-docs.museday.top)
 - **仓库**：[https://github.com/Temsys-Shen/marginnote-addon-docs](https://github.com/Temsys-Shen/marginnote-addon-docs)
 
-基于 [Starlight](https://starlight.astro.build) 构建，提供完整的 API 参考、渐进式教程与 Cookbook 配方，供开发者为 MarginNote 编写插件时查阅与学习。
+基于 [Fumadocs](https://www.fumadocs.dev) 与 Next.js 构建，提供完整的 API 参考、渐进式教程与 Cookbook 配方，供开发者为 MarginNote 编写插件时查阅与学习。
 
 ## 文档内容
 
@@ -17,8 +17,8 @@
 
 ```bash
 pnpm install
-pnpm dev      # 本地开发，默认 http://localhost:4321
-pnpm build    # 构建静态站点到 ./dist/
+pnpm dev      # 本地开发，默认 http://localhost:3000
+pnpm build    # 构建静态站点到 ./out/
 pnpm preview  # 预览构建结果
 ```
 
@@ -86,17 +86,19 @@ embedding模型使用本地BGE-small-zh-v1.5(ONNX)，首次启动会自动下载
 ```
 .
 ├── public/
+├── source.config.ts
+├── next.config.mjs
 ├── src/
-│   ├── assets/
+│   ├── app/
+│   ├── components/
 │   ├── content/
 │   │   └── docs/          # 文档正文（入门、教程、Cookbook、API 参考）
-│   └── content.config.ts
-├── astro.config.mjs
+│   └── lib/
 ├── package.json
 └── tsconfig.json
 ```
 
-文档页面为 `src/content/docs/` 下的 `.md` / `.mdx` 文件，侧栏在 `astro.config.mjs` 中配置。
+文档页面为 `src/content/docs/` 下的 `.md` / `.mdx` 文件，侧栏顺序由各目录下的 `meta.json` 配置。
 
 ## 声明
 

package/next-env.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+import "./.next/types/routes.d.ts";
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

package/next.config.mjs

@@ -0,0 +1,14 @@
+import { createMDX } from 'fumadocs-mdx/next';
+
+const withMDX = createMDX();
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+	output: 'export',
+	trailingSlash: true,
+	images: {
+		unoptimized: true,
+	},
+};
+
+export default withMDX(nextConfig);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mn-docs-mcp",
   "type": "module",
-  "version": "0.6.2",
+  "version": "1.1.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/Temsys-Shen/marginnote-addon-docs.git"
@@ -10,21 +10,36 @@
     "mn-docs-mcp": "mcp/cli.mjs"
   },
   "dependencies": {
-    "@astrojs/starlight": "^0.37.4",
     "@huggingface/transformers": "^3.7.3",
-    "@pagefind/default-ui": "^1.4.0",
-    "astro": "^5.6.1",
+    "@orama/orama": "^3.1.18",
     "fastmcp": "^3.34.0",
+    "fumadocs-core": "^16.9.3",
+    "fumadocs-mdx": "^15.0.11",
+    "fumadocs-ui": "^16.9.3",
     "gray-matter": "^4.0.3",
+    "lucide-react": "^1.18.0",
+    "next": "^16.2.9",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
     "sharp": "^0.34.2",
     "undici": "^6.19.8",
-    "zod": "^3.25.76"
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@tailwindcss/postcss": "^4.3.1",
+    "@types/mdx": "^2.0.14",
+    "@types/node": "^25.9.2",
+    "@types/react": "^19.2.17",
+    "@types/react-dom": "^19.2.3",
+    "postcss": "^8.5.15",
+    "serve": "^14.2.6",
+    "tailwindcss": "^4.3.1",
+    "typescript": "^6.0.3"
   },
   "scripts": {
-    "dev": "astro dev",
-    "start": "astro dev",
-    "build": "astro build",
-    "preview": "astro preview",
-    "astro": "astro"
+    "dev": "node scripts/sync-definitions.mjs && next dev",
+    "start": "node scripts/sync-definitions.mjs && next dev",
+    "build": "node scripts/sync-definitions.mjs && next build",
+    "preview": "serve out"
   }
 }

package/postcss.config.mjs

@@ -0,0 +1,7 @@
+const config = {
+	plugins: {
+		'@tailwindcss/postcss': {},
+	},
+};
+
+export default config;

package/scripts/sync-definitions.mjs

@@ -0,0 +1,33 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+const root = process.cwd();
+const sourceDir = path.join(root, 'src', 'definitions');
+const targetDir = path.join(root, 'public', 'definitions');
+const manifestPath = path.join(root, 'public', 'definitions-manifest.json');
+
+async function walk(dir) {
+	const entries = await fs.readdir(dir, { withFileTypes: true });
+	const files = [];
+	for (const entry of entries) {
+		const full = path.join(dir, entry.name);
+		if (entry.isDirectory()) files.push(...(await walk(full)));
+		else if (entry.isFile() && entry.name.endsWith('.h')) files.push(full);
+	}
+	return files;
+}
+
+await fs.rm(targetDir, { recursive: true, force: true });
+await fs.mkdir(targetDir, { recursive: true });
+
+const manifest = {};
+for (const file of await walk(sourceDir)) {
+	const rel = path.relative(sourceDir, file).split(path.sep).join('/');
+	const protocol = path.basename(file, '.h');
+	const target = path.join(targetDir, rel);
+	await fs.mkdir(path.dirname(target), { recursive: true });
+	await fs.copyFile(file, target);
+	manifest[protocol] = rel;
+}
+
+await fs.writeFile(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`);

package/source.config.ts

@@ -0,0 +1,5 @@
+import { defineDocs } from 'fumadocs-mdx/config';
+
+export const docs = defineDocs({
+	dir: 'src/content/docs',
+});