@movk/nuxt-docs 1.8.1 → 1.10.0

package/README.md

@@ -20,6 +20,10 @@
 
 ### 🤖 AI 增强体验
 
+<div style="padding: 40px 0; display: flex; justify-content: center;">
+  <img src="https://docs.mhaibaraai.cn/ai/AiChat.png" alt="AiChat" width="400">
+</div>
+
 - **AI 聊天助手** - 内置智能文档助手，基于 Vercel AI SDK 支持多种 LLM 模型（Mistral、Qwen、OpenRouter）
 - **MCP Server 支持** - 集成 Model Context Protocol 服务器，为 AI 助手提供结构化的文档访问能力
 - **LLM 优化** - 通过 `nuxt-llms` 模块自动生成 `llms.txt` 和 `llms-full.txt`，为 AI 工具提供优化的文档索引

package/app/assets/css/main.css

@@ -0,0 +1,40 @@
+@import "tailwindcss" theme(static) source("../../../..");
+@import "@nuxt/ui";
+
+@theme static {
+  --container-8xl: 90rem;
+
+  --font-sans: 'Public Sans', sans-serif;
+
+  --color-green-50: #EFFDF5;
+  --color-green-100: #D9FBE8;
+  --color-green-200: #B3F5D1;
+  --color-green-300: #75EDAE;
+  --color-green-400: #00DC82;
+  --color-green-500: #00C16A;
+  --color-green-600: #00A155;
+  --color-green-700: #007F45;
+  --color-green-800: #016538;
+  --color-green-900: #0A5331;
+  --color-green-950: #052E16;
+}
+
+:root {
+  --ui-container: var(--container-8xl);
+}
+
+/* Shiki icon highlight transformer styles */
+.shiki-icon-highlight {
+  display: inline-block;
+  width: 1.25em;
+  height: 1.25em;
+  vertical-align: -0.25em;
+  margin-right: 0.125em;
+  background-color: var(--ui-text-highlighted);
+  -webkit-mask-repeat: no-repeat;
+  mask-repeat: no-repeat;
+  -webkit-mask-size: 100% 100%;
+  mask-size: 100% 100%;
+  -webkit-mask-image: var(--shiki-icon-url);
+  mask-image: var(--shiki-icon-url);
+}

package/app/composables/useToolCall.ts

@@ -1,7 +1,9 @@
 export function useToolCall() {
   const tools: Record<string, string | ((args: any) => string)> = {
     'list-pages': '列出所有文档页面',
-    'get-page': (args: any) => `检索 ${args?.path || '页面'}`
+    'get-page': (args: any) => `检索 ${args?.path || '页面'}`,
+    'list-examples': '列出所有示例',
+    'get-example': (args: any) => `获取示例：${args?.exampleName || '示例'}`
   }
   return {
     tools

package/app/pages/docs/[...slug].vue

@@ -14,7 +14,7 @@ const { toc, github } = useAppConfig()
 const { data: page } = await useAsyncData(`docs-${kebabCase(route.path)}`, () => queryCollection('docs').path(route.path).first())
 
 if (!page.value) {
-  throw createError({ statusCode: 404, statusMessage: 'Page not found', fatal: true })
+  throw createError({ status: 404, statusText: 'Page not found', fatal: true })
 }
 
 const navigation = inject<Ref<ContentNavigationItem[]>>('navigation')

package/app/pages/index.vue

@@ -1,7 +1,7 @@
 <script setup lang="ts">
 const { data: page } = await useAsyncData('landing', () => queryCollection('landing').path('/').first())
 if (!page.value) {
-  throw createError({ statusCode: 404, statusMessage: 'Page not found', fatal: true })
+  throw createError({ status: 404, statusText: 'Page not found', fatal: true })
 }
 
 const title = page.value.seo?.title || page.value.title

package/app/templates/releases.vue

@@ -3,7 +3,7 @@ import type { ButtonProps } from '@nuxt/ui'
 
 const { data: page } = await useAsyncData('releases', () => queryCollection('releases').first())
 if (!page.value) {
-  throw createError({ statusCode: 404, statusMessage: 'Page not found', fatal: true })
+  throw createError({ status: 404, statusText: 'Page not found', fatal: true })
 }
 
 const title = page.value.seo?.title || page.value.title

package/app/utils/shiki-transformer-icon-highlight.ts

@@ -1,4 +1,3 @@
-/** copy from https://github.com/nuxt/ui/blob/v4/docs/app/utils/shiki-transformer-icon-highlight.ts */
 import type { ShikiTransformer } from 'shiki'
 
 export interface TransformerIconHighlightOptions {

package/content.config.ts

@@ -1,9 +1,8 @@
 import { existsSync } from 'node:fs'
 import { defineCollection, defineContentConfig } from '@nuxt/content'
 import { useNuxt } from '@nuxt/kit'
-import { asSeoCollection } from '@nuxtjs/seo/content'
 import { joinURL } from 'ufo'
-import { z } from 'zod/v4'
+import { z } from 'zod'
 
 const { options } = useNuxt()
 const cwd = joinURL(options.rootDir, 'content')
@@ -38,14 +37,14 @@ const PageHero = z.object({
 
 export default defineContentConfig({
   collections: {
-    landing: defineCollection(asSeoCollection({
+    landing: defineCollection({
       type: 'page',
       source: {
         cwd,
         include: 'index.md'
       }
-    })),
-    docs: defineCollection(asSeoCollection({
+    }),
+    docs: defineCollection({
       type: 'page',
       source: {
         cwd,
@@ -58,8 +57,8 @@ export default defineContentConfig({
           title: z.string().optional()
         })
       })
-    })),
-    releases: defineCollection(asSeoCollection({
+    }),
+    releases: defineCollection({
       type: 'page',
       source: {
         cwd,
@@ -71,6 +70,6 @@ export default defineContentConfig({
         releases: z.string(),
         hero: PageHero
       })
-    }))
+    })
   }
 })

package/modules/ai-chat/runtime/server/utils/docs_agent.ts

@@ -1,5 +1,5 @@
 import { tool, stepCountIs, generateText } from 'ai'
-import { z } from 'zod/v4'
+import { z } from 'zod'
 
 function getSubAgentSystemPrompt(siteName: string) {
   return `您是 ${siteName} 的文档搜索代理。您的工作是从文档中查找并检索相关信息。

package/modules/config.ts

@@ -1,8 +1,8 @@
 import { createResolver, defineNuxtModule } from '@nuxt/kit'
-import { join } from 'pathe'
 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: {
@@ -17,28 +17,25 @@ export default defineNuxtModule({
     const url = inferSiteURL()
     const meta = await getPackageJsonMetadata(dir)
     const gitInfo = await getLocalGitInfo(dir) || getGitEnv()
-    const siteName = nuxt.options?.site?.name || meta.name || gitInfo?.name || ''
+    const siteName = 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 || '',
+      contentRawMarkdown: false as const,
       full: {
         title: siteName,
         description: meta.description || ''
       }
     })
 
-    nuxt.options.site = defu(nuxt.options.site, {
-      url,
-      name: siteName,
-      debug: false
-    })
-
-    nuxt.options.robots = defu(nuxt.options.robots, {
-      sitemap: url ? `${url.replace(/\/$/, '')}/sitemap.xml` : undefined
-    })
-
     nuxt.options.appConfig.header = defu(nuxt.options.appConfig.header, {
       title: siteName
     })
@@ -62,34 +59,16 @@ export default defineNuxtModule({
     })
 
     const layerPath = resolve('..')
-    const allowedComponents = [
-      resolve('../app/components/content/CommitChangelog.vue'),
-      resolve('../app/components/content/ComponentEmits.vue'),
-      resolve('../app/components/content/ComponentExample.vue'),
-      resolve('../app/components/content/ComponentProps.vue'),
-      resolve('../app/components/content/ComponentSlots.vue'),
-      resolve('../app/components/content/PageLastCommit.vue'),
-      resolve('../app/components/content/Mermaid.vue'),
-      resolve('./ai-chat/runtime/components/AiChatToolCall.vue'),
-      resolve('./ai-chat/runtime/components/AiChatReasoning.vue'),
-      resolve('./ai-chat/runtime/components/AiChatSlideoverFaq.vue'),
-      resolve('./ai-chat/runtime/components/AiChatPreStream.vue')
-    ]
-    const userComponentPaths = [
-      join(dir, 'app/components'),
-      join(dir, 'components'),
-      join(dir, 'docs/app/components'),
-      join(dir, 'templates/*/app/components')
-    ]
 
     // @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 || []),
-        ({ filePath }: { filePath: string }) =>
-          filePath.startsWith(layerPath) && !allowedComponents.includes(filePath),
-        ({ filePath }: { filePath: string }) =>
-          userComponentPaths.some(path => filePath.startsWith(path))
+        ...createComponentMetaExcludeFilters(resolve, dir, layerPath, userInclude)
       ]
     })
   }

package/modules/css.ts

@@ -1,46 +1,33 @@
-import { addTemplate, createResolver, defineNuxtModule } from '@nuxt/kit'
+import { addTemplate, defineNuxtModule } from '@nuxt/kit'
+import { fileURLToPath } from 'node:url'
+import { dirname, join } from 'node:path'
 import { joinURL } from 'ufo'
+import { resolveModulePath } from 'exsolve'
 
 export default defineNuxtModule({
   meta: {
     name: 'css'
   },
-  async setup(_options, nuxt) {
-    const dir = nuxt.options.rootDir
-    const { resolve } = createResolver(import.meta.url)
+  setup(_options, nuxt) {
+    const currentDir = dirname(fileURLToPath(import.meta.url))
+    const mainCssPath = join(currentDir, '../app/assets/css/main.css')
+
+    nuxt.options.css ||= []
+    nuxt.options.css.unshift(mainCssPath)
 
-    const layerDir = resolve('../app')
-    const aiChatDir = resolve('../modules/ai-chat')
+    const dir = nuxt.options.rootDir
 
     const contentDir = joinURL(dir, 'content')
+    const uiPath = resolveModulePath('@nuxt/ui', { from: import.meta.url, conditions: ['style'] })
+    const tailwindPath = resolveModulePath('tailwindcss', { from: import.meta.url, conditions: ['style'] })
 
     const cssTemplate = addTemplate({
       filename: 'movk-nuxt-docs.css',
       getContents: () => {
-        return `@import "tailwindcss";
-@import "tailwindcss/theme.css" layer(theme) theme(static);
-@import "@nuxt/ui";
-
-@source "${contentDir.replace(/\\/g, '/')}/**/*";
-@source "${layerDir.replace(/\\/g, '/')}/**/*";
-@source "${aiChatDir.replace(/\\/g, '/')}/**/*";
-@source "../../app.config.ts";
+        return `@import ${JSON.stringify(tailwindPath)};
+@import ${JSON.stringify(uiPath)};
 
-/* Shiki icon highlight transformer styles */
-.shiki-icon-highlight {
-  display: inline-block;
-  width: 1.25em;
-  height: 1.25em;
-  vertical-align: -0.25em;
-  margin-right: 0.125em;
-  background-color: var(--ui-text-highlighted);
-  -webkit-mask-repeat: no-repeat;
-  mask-repeat: no-repeat;
-  -webkit-mask-size: 100% 100%;
-  mask-size: 100% 100%;
-  -webkit-mask-image: var(--shiki-icon-url);
-  mask-image: var(--shiki-icon-url);
-}`
+@source "${contentDir.replace(/\\/g, '/')}/**/*";`
       }
     })
 

package/modules/md-rewrite.ts

@@ -1,4 +1,4 @@
-import { defineNuxtModule } from 'nuxt/kit'
+import { defineNuxtModule } from '@nuxt/kit'
 
 export default defineNuxtModule((_options, nuxt) => {
   nuxt.hooks.hook('nitro:init', (nitro) => {

package/nuxt.config.ts

@@ -1,45 +1,27 @@
-import { createResolver, extendViteConfig } from '@nuxt/kit'
 import { defineNuxtConfig } from 'nuxt/config'
 import pkg from './package.json'
 
-const { resolve } = createResolver(import.meta.url)
-
 export default defineNuxtConfig({
   modules: [
-    resolve('./modules/config'),
     '@nuxt/ui',
     '@nuxt/content',
     '@nuxt/image',
     '@nuxt/a11y',
     '@nuxtjs/mcp-toolkit',
-    '@nuxtjs/seo',
     '@vueuse/nuxt',
     'nuxt-component-meta',
     'nuxt-llms',
-    'motion-v/nuxt',
-    () => {
-      extendViteConfig((config) => {
-        config.optimizeDeps ||= {}
-        config.optimizeDeps.include ||= []
-        config.optimizeDeps.include.push(
-          '@nuxt/content > slugify',
-          'extend',
-          '@ai-sdk/gateway > @vercel/oidc',
-          'mermaid',
-          'dompurify'
-        )
-        config.optimizeDeps.include = config.optimizeDeps.include
-          .map(id => id.replace(/^@nuxt\/content > /, '@movk/nuxt-docs > @nuxt/content > '))
-      })
-    }
+    'nuxt-og-image',
+    'motion-v/nuxt'
   ],
+
   app: {
     rootAttrs: {
       'data-vaul-drawer-wrapper': '',
       'class': 'bg-default'
     }
   },
-  // @ts-ignore - content 配置的类型定义在运行时才能正确解析
+
   content: {
     build: {
       markdown: {
@@ -56,22 +38,25 @@ export default defineNuxtConfig({
       }
     }
   },
+
   mdc: {
     highlight: {
       noApiRoute: false
     }
   },
+
   runtimeConfig: {
     public: {
       version: pkg.version
     }
   },
+
   routeRules: {
     '/llms.txt': { isr: true },
     '/llms-full.txt': { isr: true }
   },
+
   experimental: {
-    typescriptPlugin: true,
     asyncContext: true,
     defaults: {
       nuxtLink: {
@@ -79,7 +64,9 @@ export default defineNuxtConfig({
       }
     }
   },
+
   compatibilityDate: 'latest',
+
   nitro: {
     prerender: {
       crawlLinks: true,
@@ -87,15 +74,36 @@ export default defineNuxtConfig({
       autoSubfolderIndex: false
     }
   },
+
+  hooks: {
+    // Rewrite optimizeDeps paths for layer architecture
+    'vite:extendConfig': (config) => {
+      const include = config.optimizeDeps?.include
+      if (!include) return
+
+      const layerPkgs = /^(?:@nuxt\/content|@nuxtjs\/mdc|@nuxt\/a11y) > /
+      include.forEach((id, i) => {
+        if (layerPkgs.test(id)) include[i] = `@movk/nuxt-docs > ${id}`
+      })
+
+      // Layer dependencies that need pre-bundling
+      include.push(
+        '@movk/nuxt-docs > @nuxt/content > slugify',
+        '@movk/nuxt-docs > @ai-sdk/gateway > @vercel/oidc'
+      )
+    }
+  },
+
   a11y: {
     logIssues: false
   },
+
   componentMeta: {
     metaFields: {
       type: false,
       props: true,
-      slots: 'no-schema' as const,
-      events: 'no-schema' as const,
+      slots: 'no-schema',
+      events: 'no-schema',
       exposed: false
     },
     exclude: [
@@ -110,6 +118,7 @@ export default defineNuxtConfig({
       'nuxt-og-image'
     ]
   },
+
   fonts: {
     families: [
       { name: 'Public Sans', provider: 'google', global: true },
@@ -121,9 +130,11 @@ export default defineNuxtConfig({
       { name: 'Raleway', provider: 'google', global: true }
     ]
   },
+
   icon: {
     provider: 'iconify'
   },
+
   ogImage: {
     zeroRuntime: true,
     googleFontMirror: 'fonts.loli.net',
@@ -134,8 +145,5 @@ export default defineNuxtConfig({
       'Inter:400',
       'Inter:700'
     ]
-  },
-  sitemap: {
-    zeroRuntime: true
   }
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@movk/nuxt-docs",
   "type": "module",
-  "version": "1.8.1",
+  "version": "1.10.0",
   "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>",
@@ -14,7 +14,8 @@
   "main": "./nuxt.config.ts",
   "peerDependencies": {
     "better-sqlite3": "12.x",
-    "nuxt": "4.x"
+    "nuxt": "4.x",
+    "tailwindcss": "4.x"
   },
   "files": [
     "app",
@@ -28,38 +29,40 @@
     "README.md"
   ],
   "dependencies": {
-    "@ai-sdk/gateway": "^3.0.19",
-    "@ai-sdk/mcp": "^1.0.11",
-    "@ai-sdk/vue": "^3.0.45",
-    "@iconify-json/lucide": "^1.2.86",
+    "@ai-sdk/gateway": "^3.0.29",
+    "@ai-sdk/mcp": "^1.0.15",
+    "@ai-sdk/vue": "^3.0.62",
+    "@iconify-json/lucide": "^1.2.87",
     "@iconify-json/ph": "^1.2.2",
-    "@iconify-json/simple-icons": "^1.2.67",
+    "@iconify-json/simple-icons": "^1.2.68",
     "@iconify-json/tabler": "^1.2.26",
     "@iconify-json/vscode-icons": "^1.2.40",
     "@movk/core": "^1.1.0",
     "@nuxt/a11y": "^1.0.0-alpha.1",
     "@nuxt/content": "^3.11.0",
     "@nuxt/image": "^2.0.0",
-    "@nuxt/kit": "^4.2.2",
+    "@nuxt/kit": "^4.3.0",
     "@nuxt/ui": "^4.4.0",
     "@nuxtjs/mcp-toolkit": "^0.6.2",
-    "@nuxtjs/seo": "^3.3.0",
+    "@nuxtjs/mdc": "^0.20.0",
     "@octokit/rest": "^22.0.1",
-    "@openrouter/ai-sdk-provider": "^2.0.0",
+    "@openrouter/ai-sdk-provider": "^2.1.1",
     "@vercel/analytics": "^1.6.1",
     "@vercel/speed-insights": "^1.3.1",
     "@vueuse/core": "^14.1.0",
     "@vueuse/nuxt": "^14.1.0",
-    "ai": "^6.0.45",
+    "ai": "^6.0.62",
     "defu": "^6.1.4",
     "dompurify": "^3.3.1",
     "exsolve": "^1.0.8",
     "git-url-parse": "^16.1.0",
     "mermaid": "^11.12.2",
-    "motion-v": "^1.9.0",
-    "nuxt": "^4.2.2",
+    "minimark": "^0.2.0",
+    "motion-v": "^1.10.2",
+    "nuxt": "^4.3.0",
     "nuxt-component-meta": "^0.17.1",
     "nuxt-llms": "^0.2.0",
+    "nuxt-og-image": "^5.1.13",
     "ohash": "^2.0.11",
     "pathe": "^2.0.3",
     "pkg-types": "^2.3.0",
@@ -69,7 +72,9 @@
     "shiki-stream": "^0.1.4",
     "shiki-transformer-color-highlight": "^1.0.0",
     "tailwindcss": "^4.1.18",
+    "tailwind-merge": "^3.4.0",
     "ufo": "^1.6.3",
-    "zod": "^4.3.5"
+    "zod": "^4.3.6",
+    "vue-component-meta": "^3.2.4"
   }
 }

package/server/api/component-example.get.ts

@@ -10,8 +10,8 @@ export default defineEventHandler((event) => {
     const component = components[pascalCase(componentName)]
     if (!component) {
       throw createError({
-        statusMessage: 'Example not found!',
-        statusCode: 404
+        statusText: 'Example not found!',
+        status: 404
       })
     }
     return component

package/server/api/github/commits.get.ts

@@ -10,8 +10,8 @@ export default defineCachedEventHandler(async (event) => {
 
   if (!paths.length || !paths[0]) {
     throw createError({
-      statusCode: 400,
-      statusMessage: 'Path is required'
+      status: 400,
+      statusText: 'Path is required'
     })
   }
 
@@ -19,8 +19,8 @@ export default defineCachedEventHandler(async (event) => {
 
   if (!github || typeof github === 'boolean') {
     throw createError({
-      statusCode: 500,
-      statusMessage: 'GitHub configuration is not available'
+      status: 500,
+      statusText: 'GitHub configuration is not available'
     })
   }
 

package/server/api/github/last-commit.get.ts

@@ -8,8 +8,8 @@ export default defineCachedEventHandler(async (event) => {
   const { path } = getQuery(event) as { path: string }
   if (!path) {
     throw createError({
-      statusCode: 400,
-      statusMessage: 'Path is required'
+      status: 400,
+      statusText: 'Path is required'
     })
   }
 
@@ -17,8 +17,8 @@ export default defineCachedEventHandler(async (event) => {
 
   if (!github || typeof github === 'boolean') {
     throw createError({
-      statusCode: 500,
-      statusMessage: 'GitHub configuration is not available'
+      status: 500,
+      statusText: 'GitHub configuration is not available'
     })
   }
 

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

@@ -0,0 +1,19 @@
+import { z } from 'zod'
+
+export default defineMcpTool({
+  description: '检索特定的 UI 示例实现代码和详细信息',
+  inputSchema: {
+    exampleName: z.string().describe('示例名称（PascalCase）')
+  },
+  cache: '30m',
+  async handler({ exampleName }) {
+    try {
+      const result = await $fetch<{ code: string }>(`/api/component-example/${exampleName}.json`)
+      return {
+        content: [{ type: 'text' as const, text: result.code }]
+      }
+    } catch {
+      return errorResult(`示例 '${exampleName}' 未找到。使用 list_examples 工具查看所有可用示例。`)
+    }
+  }
+})