@movk/nuxt-docs 1.16.0 → 1.16.2

package/README.md

@@ -1,3 +1,4 @@
+[![Movk Nuxt Docs OG](https://docs.mhaibaraai.cn/_og/s/c_Docs,title_~546w5Luj5YyWIE51eHQg5paH5qGj5Li76aKY,description_~5Z-65LqOIE51eHQgNCDnmoTnjrDku6PmlofmoaPkuLvpopjvvIzpm4bmiJDnu4Tku7boh6rliqjljJbmlofmoaPjgIFBSSDogYrlpKnliqnmiYvjgIFNQ1AgU2VydmVyIOWSjOWujOaVtOeahOW8gOWPkeiAheS9k-mqjOS8mOWMluOAgg.png)](https://docs.mhaibaraai.cn/)
 [![Movk Nuxt Docs](https://docs.mhaibaraai.cn/og-image.png)](https://docs.mhaibaraai.cn/)
 
 > 基于 Nuxt 4 的现代文档主题，集成组件自动化文档、AI 聊天助手、MCP Server 和完整的开发者体验优化
@@ -21,7 +22,7 @@
 ### 🤖 AI 增强体验
 
 <div style="padding: 40px 0; display: flex; justify-content: center;">
-  <img src="https://docs.mhaibaraai.cn/ai/AiChat.png" alt="AiChat" width="400">
+<img src="https://docs.mhaibaraai.cn/ai/AiChat.png" alt="AiChat" width="400">
 </div>
 
 - **AI 聊天助手** - 内置智能文档助手，基于 Vercel AI SDK 支持多种 LLM 模型
@@ -201,11 +202,11 @@ export default defineNuxtConfig({
 ````md [md]
 ```mermaid
 graph TD
-    A[开始] --> B{是否有效?}
-    B -->|是| C[处理数据]
-    B -->|否| D[显示错误]
-    C --> E[完成]
-    D --> E
+A[开始] --> B{是否有效?}
+B -->|是| C[处理数据]
+B -->|否| D[显示错误]
+C --> E[完成]
+D --> E
 ```
 ````
 
@@ -218,9 +219,9 @@ graph TD
 
 **支持的图表类型：**
 - **流程图**（`flowchart`/`graph`）：用于展示流程和决策
-  ![Mermaid 流程图示例](https://docs.mhaibaraai.cn/mermaid/mermaid-flowchart.png)
+![Mermaid 流程图示例](https://docs.mhaibaraai.cn/mermaid/mermaid-flowchart.png)
 - **时序图**（`sequenceDiagram`）：用于展示交互时序
-  ![Mermaid 时序图示例](https://docs.mhaibaraai.cn/mermaid/mermaid-sequence.png)
+![Mermaid 时序图示例](https://docs.mhaibaraai.cn/mermaid/mermaid-sequence.png)
 - **类图**（`classDiagram`）：用于展示类关系
 - **状态图**（`stateDiagram`）：用于展示状态转换
 - **甘特图**（`gantt`）：用于展示项目时间线

package/app/app.config.ts

@@ -22,7 +22,6 @@ export default defineAppConfig({
   },
   header: {
     avatar: 'https://docs.mhaibaraai.cn/avatar.png',
-    title: 'Movk Nuxt Docs',
     to: '/',
     search: true,
     colorMode: true,

package/modules/ai-chat/runtime/components/AiChatPanel.vue

@@ -98,8 +98,11 @@ function getToolIcon(part: ToolPart): string {
   const { toolIcon } = useToolCall(part.state, toolName, part.input || {} as any)
 
   const iconMap: Record<string, string> = {
-    'get-page': 'i-lucide-file-text',
-    'get-example': 'i-lucide-file-text',
+    'get-page': 'i-lucide-book-open',
+    'get-example': 'i-lucide-codepen',
+    'list-examples': 'i-lucide-codesandbox',
+    'list-getting-started-guides': 'i-lucide-square-play',
+    'list-pages': 'i-lucide-book-minus',
     ...toolIcon
   }
 

package/modules/module.ts

@@ -1,5 +1,11 @@
 import { addComponentsDir, createResolver, defineNuxtModule, logger } from '@nuxt/kit'
 import type { ModuleDependencies } from 'nuxt/schema'
+import { defu } from 'defu'
+import { getGitBranch, getGitEnv, getLocalGitInfo } from '../utils/git'
+import { getPackageJsonMetadata, inferSiteURL } from '../utils/meta'
+import { createComponentMetaExcludeFilters } from '../utils/component-meta'
+import { startCase, kebabCase } from '@movk/core'
+import { updateSiteConfig } from 'nuxt-site-config/kit'
 
 export interface ModuleOptions {
   /**
@@ -29,17 +35,23 @@ export default defineNuxtModule<ModuleOptions>({
   },
   moduleDependencies(nuxt): ModuleDependencies {
     const userOptions = nuxt.options.movkNuxtDocs || {}
+
     return {
       ...userOptions.a11y !== false && {
         '@nuxt/a11y': {
-          version: '^1.0.0-alpha.1'
+          version: '^1.0.0-alpha.1',
+          defaults: {
+            logIssues: false
+          }
         }
       }
     }
   },
-  setup(options, nuxt) {
+  async setup(options, nuxt) {
     const { resolve } = createResolver(import.meta.url)
 
+    nuxt.options.alias['#ai-chat'] = resolve('./ai-chat/runtime')
+
     if (options.mermaid) {
       let mermaidAvailable = true
       try {
@@ -93,6 +105,74 @@ export default defineNuxtModule<ModuleOptions>({
         log.info('mermaid diagram support enabled')
       }
     }
+
+    const dir = nuxt.options.rootDir
+    const url = inferSiteURL()
+    const meta = await getPackageJsonMetadata(dir)
+    const gitInfo = await getLocalGitInfo(dir) || getGitEnv()
+
+    const site = defu(nuxt.options.site, {
+      url,
+      name: kebabCase(meta.name || gitInfo?.name || ''),
+      debug: false
+    })
+    updateSiteConfig(site)
+
+    const siteName = (typeof nuxt.options.site === 'object' && nuxt.options.site?.name) || meta.name || gitInfo?.name || ''
+
+    nuxt.options.llms = defu(nuxt.options.llms, {
+      domain: url || 'https://example.com',
+      title: siteName,
+      description: meta.description || '',
+      full: {
+        title: siteName,
+        description: meta.description || ''
+      }
+    })
+
+    nuxt.options.appConfig.header = defu(nuxt.options.appConfig.header, {
+      title: startCase(siteName)
+    })
+
+    nuxt.options.appConfig.seo = defu(nuxt.options.appConfig.seo, {
+      titleTemplate: `%s - ${siteName}`,
+      title: siteName,
+      description: meta.description || ''
+    })
+
+    nuxt.options.appConfig.github = defu(nuxt.options.appConfig.github, {
+      owner: gitInfo?.owner,
+      name: gitInfo?.name,
+      url: gitInfo?.url,
+      commitPath: 'src',
+      suffix: 'vue',
+      since: '2025-01-31T04:00:00Z',
+      branch: getGitBranch(),
+      per_page: 100,
+      until: new Date().toISOString()
+    })
+
+    const layerPath = resolve('..')
+
+    // @ts-ignore - component-meta is not typed
+    nuxt.hook('component-meta:extend', (options: any) => {
+      const userInclude = (nuxt.options.componentMeta && typeof nuxt.options.componentMeta === 'object')
+        ? nuxt.options.componentMeta.include || []
+        : []
+
+      options.exclude = [
+        ...(options.exclude || []),
+        ...createComponentMetaExcludeFilters(resolve, dir, layerPath, userInclude)
+      ]
+    })
+
+    nuxt.hook('nitro:config', (nitroConfig) => {
+      nitroConfig.publicAssets ||= []
+      nitroConfig.publicAssets.push({
+        dir: resolve('./runtime/public'),
+        maxAge: 60 * 60 * 24 * 30
+      })
+    })
   }
 })
 

package/nuxt.config.ts

@@ -145,10 +145,6 @@ export default defineNuxtConfig({
     }
   },
 
-  a11y: {
-    logIssues: false
-  },
-
   componentMeta: {
     metaFields: {
       type: false,
@@ -172,7 +168,7 @@ export default defineNuxtConfig({
 
   fonts: {
     families: [
-      { name: 'Public Sans', global: true, provider: 'bunny' },
+      { name: 'Public Sans', global: true },
       { name: 'Noto Sans SC', global: true, provider: 'local' }
     ]
   },
@@ -194,5 +190,19 @@ export default defineNuxtConfig({
     // Must be defined before @nuxt/content setup,
     // otherwise Content LLMS module will overwrite it in modules:done.
     contentRawMarkdown: false
+  },
+
+  ogImage: {
+    zeroRuntime: true
+  },
+
+  robots: {
+    groups: [
+      {
+        userAgent: '*',
+        allow: '/'
+      }
+    ],
+    sitemap: '/sitemap.xml'
   }
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@movk/nuxt-docs",
   "type": "module",
-  "version": "1.16.0",
+  "version": "1.16.2",
   "private": false,
   "description": "Modern Nuxt 4 documentation theme with auto-generated component docs, AI chat assistant, MCP server, and complete developer experience optimization.",
   "author": "YiXuan <mhaibaraai@gmail.com>",
@@ -41,7 +41,7 @@
   "dependencies": {
     "@ai-sdk/gateway": "^3.0.83",
     "@ai-sdk/mcp": "^1.0.30",
-    "@ai-sdk/vue": "^3.0.140",
+    "@ai-sdk/vue": "^3.0.141",
     "@iconify-json/lucide": "^1.2.100",
     "@iconify-json/simple-icons": "^1.2.75",
     "@iconify-json/vscode-icons": "^1.2.45",
@@ -70,7 +70,8 @@
     "motion-v": "^2.2.0",
     "nuxt-component-meta": "^0.17.2",
     "nuxt-llms": "^0.2.0",
-    "nuxt-og-image": "^6.2.6",
+    "nuxt-og-image": "^6.3.0",
+    "nuxt-site-config": "^4.0.7",
     "ohash": "^2.0.11",
     "pathe": "^2.0.3",
     "pkg-types": "^2.3.0",

package/server/mcp/tools/get-example.ts

@@ -13,7 +13,7 @@ export default defineMcpTool({
         content: [{ type: 'text' as const, text: result.code }]
       }
     } catch {
-      return errorResult(`示例 '${exampleName}' 未找到。使用 list_examples 工具查看所有可用示例。`)
+      throw createError({ statusCode: 404, message: `示例 '${exampleName}' 未找到。使用 list_examples 工具查看所有可用示例。` })
     }
   }
 })

package/server/mcp/tools/get-page.ts

@@ -22,7 +22,7 @@ export default defineMcpTool({
         content: [{ type: 'text', text: JSON.stringify(content, null, 2) }]
       }
     } catch (error) {
-      return errorResult(`获取页面失败: ${error}`)
+      throw createError({ statusCode: 500, message: `获取页面失败: ${error}` })
     }
   }
 })

package/server/mcp/tools/list-examples.ts

@@ -5,6 +5,6 @@ export default defineMcpTool({
   description: '列出所有可用的示例和代码演示',
   cache: '1h',
   async handler() {
-    return jsonResult(await listComponentExamples())
+    return await listComponentExamples()
   }
 })

package/server/mcp/tools/list-getting-started-guides.ts

@@ -22,6 +22,6 @@ export default defineMcpTool({
       navigation: page.navigation
     })).sort((a, b) => a.path.localeCompare(b.path))
 
-    return jsonResult(result)
+    return result
   }
 })

package/server/mcp/tools/list-pages.ts

@@ -8,10 +8,10 @@ export default defineMcpTool({
 
     const pages = await queryCollection(event, 'docs').all()
 
-    return jsonResult(pages.map(doc => ({
+    return pages.map(doc => ({
       title: doc.title,
       description: doc.description,
       path: doc.path
-    })))
+    }))
   }
 })

package/modules/config.ts

@@ -1,84 +0,0 @@
-import { createResolver, defineNuxtModule } from '@nuxt/kit'
-import { defu } from 'defu'
-import { getGitBranch, getGitEnv, getLocalGitInfo } from '../utils/git'
-import { getPackageJsonMetadata, inferSiteURL } from '../utils/meta'
-import { createComponentMetaExcludeFilters } from '../utils/component-meta'
-
-export default defineNuxtModule({
-  meta: {
-    name: 'config'
-  },
-  async setup(_options, nuxt) {
-    const { resolve } = createResolver(import.meta.url)
-
-    nuxt.options.alias['#ai-chat'] = resolve('./ai-chat/runtime')
-
-    const dir = nuxt.options.rootDir
-    const url = inferSiteURL()
-    const meta = await getPackageJsonMetadata(dir)
-    const gitInfo = await getLocalGitInfo(dir) || getGitEnv()
-
-    const site = nuxt.options.site
-    const siteName = (site && site.name) || meta.name || gitInfo?.name || ''
-
-    nuxt.options.site = defu(nuxt.options.site, {
-      url,
-      name: siteName,
-      debug: false
-    })
-
-    nuxt.options.llms = defu(nuxt.options.llms, {
-      domain: url || 'https://example.com',
-      title: siteName,
-      description: meta.description || '',
-      full: {
-        title: siteName,
-        description: meta.description || ''
-      }
-    })
-
-    nuxt.options.appConfig.header = defu(nuxt.options.appConfig.header, {
-      title: siteName
-    })
-
-    nuxt.options.appConfig.seo = defu(nuxt.options.appConfig.seo, {
-      titleTemplate: `%s - ${siteName}`,
-      title: siteName,
-      description: meta.description || ''
-    })
-
-    nuxt.options.appConfig.github = defu(nuxt.options.appConfig.github, {
-      owner: gitInfo?.owner,
-      name: gitInfo?.name,
-      url: gitInfo?.url,
-      commitPath: 'src',
-      suffix: 'vue',
-      since: '2025-01-31T04:00:00Z',
-      branch: getGitBranch(),
-      per_page: 100,
-      until: new Date().toISOString()
-    })
-
-    const layerPath = resolve('..')
-
-    // @ts-ignore - component-meta is not typed
-    nuxt.hook('component-meta:extend', (options: any) => {
-      const userInclude = (nuxt.options.componentMeta && typeof nuxt.options.componentMeta === 'object')
-        ? nuxt.options.componentMeta.include || []
-        : []
-
-      options.exclude = [
-        ...(options.exclude || []),
-        ...createComponentMetaExcludeFilters(resolve, dir, layerPath, userInclude)
-      ]
-    })
-
-    nuxt.hook('nitro:config', (nitroConfig) => {
-      nitroConfig.publicAssets ||= []
-      nitroConfig.publicAssets.push({
-        dir: resolve('./runtime/public'),
-        maxAge: 60 * 60 * 24 * 30
-      })
-    })
-  }
-})