@movk/nuxt-docs 1.7.3 → 1.7.5

package/app/error.vue

@@ -47,11 +47,11 @@ provide('navigation', rootNavigation)
     <NuxtLoadingIndicator color="var(--ui-primary)" :height="2" />
 
     <div :class="{ root: route.path.startsWith('/docs/') }">
-      <Header />
+      <Header v-if="$route.meta.header !== false" />
 
       <UError :error="error" />
 
-      <Footer />
+      <Footer v-if="$route.meta.footer !== false" />
 
       <ClientOnly>
         <LazyUContentSearch :files="files" :navigation="navigation" />

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

@@ -1,6 +1,7 @@
 <script setup lang="ts">
 import type { ContentNavigationItem } from '@nuxt/content'
 import { kebabCase } from 'scule'
+import { joinURL } from 'ufo'
 
 definePageMeta({
   layout: 'docs',
@@ -80,6 +81,20 @@ const communityLinks = computed(() => {
   return filterValidLinks([...links, ...(toc?.bottom?.links || [])])
 })
 
+// Pre-render the markdown path + add it to alternate links
+const site = useSiteConfig()
+const path = computed(() => route.path.replace(/\/$/, ''))
+prerenderRoutes([joinURL('/raw', `${path.value}.md`)])
+useHead({
+  link: [
+    {
+      rel: 'alternate',
+      href: joinURL(site.url, 'raw', `${path.value}.md`),
+      type: 'text/markdown'
+    }
+  ]
+})
+
 useSeoMeta({
   title,
   ogTitle: title,

package/app/workers/prettier.js

@@ -16,12 +16,12 @@ function handleMessage(message) {
 async function handleFormatMessage(message) {
   if (!globalThis.prettier) {
     await Promise.all([
-      import('https://cdn.jsdelivr.net/npm/prettier@3.6.2/standalone.js'),
-      import('https://cdn.jsdelivr.net/npm/prettier@3.6.2/plugins/babel.js'),
-      import('https://cdn.jsdelivr.net/npm/prettier@3.6.2/plugins/estree.js'),
-      import('https://cdn.jsdelivr.net/npm/prettier@3.6.2/plugins/html.js'),
-      import('https://cdn.jsdelivr.net/npm/prettier@3.6.2/plugins/markdown.js'),
-      import('https://cdn.jsdelivr.net/npm/prettier@3.6.2/plugins/typescript.js')
+      import('https://cdn.jsdelivr.net/npm/prettier@3.7.4/standalone.js'),
+      import('https://cdn.jsdelivr.net/npm/prettier@3.7.4/plugins/babel.js'),
+      import('https://cdn.jsdelivr.net/npm/prettier@3.7.4/plugins/estree.js'),
+      import('https://cdn.jsdelivr.net/npm/prettier@3.7.4/plugins/html.js'),
+      import('https://cdn.jsdelivr.net/npm/prettier@3.7.4/plugins/markdown.js'),
+      import('https://cdn.jsdelivr.net/npm/prettier@3.7.4/plugins/typescript.js')
     ])
   }
 

package/modules/ai-chat/index.ts

@@ -32,7 +32,7 @@ export interface AiChatModuleOptions {
   models?: string[]
 }
 
-const log = logger.withTag('docus:ai-assistant')
+const log = logger.withTag('movk-nuxt-docs:ai-assistant')
 
 export default defineNuxtModule<AiChatModuleOptions>({
   meta: {

package/modules/ai-chat/runtime/server/api/ai-chat.ts

@@ -4,37 +4,27 @@ import { createDocumentationAgentTool } from '../utils/docs_agent'
 import { getModel } from '../utils/getModel'
 
 function getMainAgentSystemPrompt(siteName: string) {
-  return `You are the official documentation assistant for ${siteName}. You ARE the documentation - speak with authority as the source of truth.
+  return `您是 ${siteName} 的官方文档助理。你就是文件、以权威作为真理的来源说话.
 
-**Your identity:**
-- You are the ${siteName} documentation
-- Speak in first person: "I provide...", "You can use my tools to...", "I support..."
-- Be confident and authoritative - you know this project inside out
-- Never say "according to the documentation" - YOU are the docs
+使用指南：
+- 始终使用工具搜索信息，不要依赖预训练知识
+- 如果搜索后未找到相关信息，回复「抱歉，我在文档中没有找到相关信息」
+- 回答要简洁直接
 
-**Tool usage (CRITICAL):**
-- You have ONE tool: searchDocumentation
-- Use it for EVERY question - pass the user's question as the query
-- The tool will search the documentation and return relevant information
-- Use the returned information to formulate your response
+**格式规则（重要）：**
+- 绝对不要使用 Markdown 标题：禁止使用 #、##、###、####、#####、######
+- 不要使用下划线式标题（=== 或 ---）
+- 使用**粗体文本**来强调和标记章节
+- 示例：
+  * 不要写「## 用法」，应写「**用法：**」或直接「使用方法如下：」
+  * 不要写「# 完整指南」，应写「**完整指南**」或直接开始内容
+- 所有回复直接从内容开始，不要以标题开头
 
-**Guidelines:**
-- If the tool can't find something, say "I don't have documentation on that yet"
-- Be concise, helpful, and direct
-- Guide users like a friendly expert would
-
-**FORMATTING RULES (CRITICAL):**
-- NEVER use markdown headings (#, ##, ###, etc.)
-- Use **bold text** for emphasis and section labels
-- Start responses with content directly, never with a heading
-- Use bullet points for lists
-- Keep code examples focused and minimal
-
-**Response style:**
-- Conversational but professional
-- "Here's how you can do that:" instead of "The documentation shows:"
-- "I support TypeScript out of the box" instead of "The module supports TypeScript"
-- Provide actionable guidance, not just information dumps`
+- 在适用时引用具体的组件名称、属性或 API
+- 如果问题模糊，请要求澄清而不是猜测
+- 当找到多个相关项目时，使用项目符号清晰列出
+- 你最多有 6 次工具调用机会来找到答案，因此要策略性地使用：先广泛搜索，然后根据需要获取具体信息
+- 以对话方式格式化回复，而不是文档章节形式`
 }
 
 export default defineEventHandler(async (event) => {
@@ -71,7 +61,7 @@ export default defineEventHandler(async (event) => {
         maxOutputTokens: 10000,
         system: getMainAgentSystemPrompt(siteName),
         messages: modelMessages,
-        stopWhen: stepCountIs(5),
+        stopWhen: stepCountIs(6),
         tools: {
           searchDocumentation
         },

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

@@ -2,21 +2,18 @@ import { tool, stepCountIs, generateText } from 'ai'
 import { z } from 'zod/v4'
 
 function getSubAgentSystemPrompt(siteName: string) {
-  return `You are a documentation search agent for ${siteName}. Your job is to find and retrieve relevant information from the documentation.
+  return `您是 ${siteName} 的文档搜索代理。您的工作是从文档中查找并检索相关信息。
 
-**Your task:**
-- Use the available tools to search and read documentation pages
-- Start with list-pages to discover what documentation exists
-- Then use get-page to read the relevant page(s)
-- If a specific path is mentioned, you can call get-page directly
+**您的任务：**
+- 使用可用的工具搜索和阅读文档页面
 
-**Guidelines:**
-- Be thorough - read all relevant pages before answering
-- Return the raw information you find, let the main agent format the response
-- If you can't find information, say so clearly
+**指南：**
+- 在回答之前阅读所有相关页面
+- 返回你找到的原始信息，让主代理格式化响应
+- 如果找不到信息，请明确说明
 
-**Output:**
-Return the relevant documentation content you found, including code examples if present.`
+**输出：**
+返回您找到的相关文档内容，包括代码示例（如果存在）。`
 }
 
 export function createDocumentationAgentTool(mcpTools: Record<string, any>, model: any, siteName: string) {
@@ -32,7 +29,7 @@ export function createDocumentationAgentTool(mcpTools: Record<string, any>, mode
         model,
         tools: mcpTools,
         system: getSubAgentSystemPrompt(siteName),
-        stopWhen: stepCountIs(5),
+        stopWhen: stepCountIs(6),
         onStepFinish: ({ toolCalls }) => {
           if (toolCalls.length === 0) return
 

package/modules/config.ts

@@ -1,4 +1,5 @@
 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'
@@ -57,40 +58,35 @@ export default defineNuxtModule({
       until: new Date().toISOString()
     })
 
-    const componentsPath = resolve('../app/components')
+    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('./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')
+    ]
 
-    nuxt.options.componentMeta = defu(nuxt.options.componentMeta, {
-      exclude: [
-        '@nuxt/content',
-        '@nuxt/icon',
-        '@nuxt/image',
-        '@nuxtjs/color-mode',
-        '@nuxtjs/mdc',
-        'nuxt/dist',
-        'nuxt-og-image',
-        '@nuxtjs/plausible',
-        '@nuxt/ui',
-        (component: { filePath: string }) => {
-          const allowedComponents = [
-            'CommitChangelog.vue',
-            'ComponentEmits.vue',
-            'ComponentExample.vue',
-            'ComponentProps.vue',
-            'ComponentSlots.vue',
-            'PageLastCommit.vue',
-            'Motion.vue'
-          ]
-          return component.filePath.startsWith(componentsPath)
-            && !allowedComponents.some(name => component.filePath.endsWith(`/content/${name}`))
-        }
-      ],
-      metaFields: {
-        type: false,
-        props: true,
-        slots: 'no-schema' as const,
-        events: 'no-schema' as const,
-        exposed: false
-      }
+    // @ts-ignore - component-meta 的类型定义在运行时才能正确解析
+    nuxt.hook('component-meta:extend', (options: any) => {
+      options.exclude = [
+        ...(options.exclude || []),
+        ({ filePath }: { filePath: string }) =>
+          filePath.startsWith(layerPath) && !allowedComponents.includes(filePath),
+        ({ filePath }: { filePath: string }) =>
+          userComponentPaths.some(path => filePath.startsWith(path))
+      ]
     })
   }
 })

package/modules/md-rewrite.ts

@@ -0,0 +1,23 @@
+import { defineNuxtModule } from 'nuxt/kit'
+
+export default defineNuxtModule((_options, nuxt) => {
+  nuxt.hooks.hook('nitro:init', (nitro) => {
+    if (nitro.options.dev || !nitro.options.preset.includes('vercel')) {
+      return
+    }
+    nitro.hooks.hook('compiled', async () => {
+      const { resolve } = process.getBuiltinModule('node:path')
+      const { readFile, writeFile }
+        = process.getBuiltinModule('node:fs/promises')
+      const vcJSON = resolve(nitro.options.output.dir, 'config.json')
+      const vcConfig = JSON.parse(await readFile(vcJSON, 'utf8'))
+      vcConfig.routes.unshift({
+        src: '^/docs/(.*)$',
+        dest: '/raw/docs/$1.md',
+        has: [{ type: 'header', key: 'accept', value: '(.*)text/markdown(.*)' }],
+        check: true
+      })
+      await writeFile(vcJSON, JSON.stringify(vcConfig, null, 2), 'utf8')
+    })
+  })
+})

package/nuxt.config.ts

@@ -7,20 +7,16 @@ const { resolve } = createResolver(import.meta.url)
 export default defineNuxtConfig({
   modules: [
     resolve('./modules/config'),
-    resolve('./modules/routing'),
-    resolve('./modules/css'),
-    resolve('./modules/component-example'),
-    resolve('./modules/ai-chat'),
     '@nuxt/ui',
     '@nuxt/content',
     '@nuxt/image',
     '@nuxt/a11y',
-    '@vueuse/nuxt',
     '@nuxtjs/mcp-toolkit',
     '@nuxtjs/seo',
+    '@vueuse/nuxt',
     'nuxt-component-meta',
-    'motion-v/nuxt',
     'nuxt-llms',
+    'motion-v/nuxt',
     () => {
       extendViteConfig((config) => {
         config.optimizeDeps ||= {}
@@ -92,6 +88,26 @@ export default defineNuxtConfig({
   a11y: {
     logIssues: false
   },
+  componentMeta: {
+    metaFields: {
+      type: false,
+      props: true,
+      slots: 'no-schema' as const,
+      events: 'no-schema' as const,
+      exposed: false
+    },
+    exclude: [
+      '@nuxt/ui',
+      '@nuxt/content',
+      '@nuxt/icon',
+      '@nuxt/image',
+      '@nuxtjs/color-mode',
+      '@nuxtjs/mdc',
+      '@nuxtjs/plausible',
+      'nuxt/dist',
+      'nuxt-og-image'
+    ]
+  },
   fonts: {
     families: [
       { name: 'Public Sans', provider: 'google', global: true },
@@ -106,9 +122,6 @@ export default defineNuxtConfig({
   icon: {
     provider: 'iconify'
   },
-  linkChecker: {
-    enabled: false
-  },
   ogImage: {
     zeroRuntime: true,
     googleFontMirror: 'fonts.loli.net',
@@ -119,5 +132,8 @@ 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.7.3",
+  "version": "1.7.5",
   "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>",
@@ -28,15 +28,17 @@
     "README.md"
   ],
   "dependencies": {
-    "@ai-sdk/gateway": "^3.0.13",
-    "@ai-sdk/mcp": "^1.0.6",
-    "@ai-sdk/vue": "^3.0.33",
-    "@iconify-json/lucide": "^1.2.84",
-    "@iconify-json/simple-icons": "^1.2.66",
-    "@iconify-json/vscode-icons": "^1.2.38",
+    "@ai-sdk/gateway": "^3.0.16",
+    "@ai-sdk/mcp": "^1.0.10",
+    "@ai-sdk/vue": "^3.0.41",
+    "@iconify-json/lucide": "^1.2.86",
+    "@iconify-json/ph": "^1.2.2",
+    "@iconify-json/tabler": "^1.2.26",
+    "@iconify-json/simple-icons": "^1.2.67",
+    "@iconify-json/vscode-icons": "^1.2.40",
     "@movk/core": "^1.1.0",
     "@nuxt/a11y": "^1.0.0-alpha.1",
-    "@nuxt/content": "^3.10.0",
+    "@nuxt/content": "^3.11.0",
     "@nuxt/image": "^2.0.0",
     "@nuxt/kit": "^4.2.2",
     "@nuxt/ui": "^4.3.0",
@@ -48,24 +50,24 @@
     "@vercel/speed-insights": "^1.3.1",
     "@vueuse/core": "^14.1.0",
     "@vueuse/nuxt": "^14.1.0",
-    "ai": "^6.0.33",
+    "ai": "^6.0.41",
     "defu": "^6.1.4",
     "exsolve": "^1.0.8",
     "git-url-parse": "^16.1.0",
     "motion-v": "^1.9.0",
     "nuxt": "^4.2.2",
-    "nuxt-component-meta": "^0.16.0",
-    "nuxt-llms": "^0.1.3",
+    "nuxt-component-meta": "^0.17.1",
+    "nuxt-llms": "^0.2.0",
     "ohash": "^2.0.11",
     "pathe": "^2.0.3",
     "pkg-types": "^2.3.0",
-    "prettier": "^3.7.4",
+    "prettier": "^3.8.0",
     "scule": "^1.3.0",
     "shiki": "^3.21.0",
     "shiki-stream": "^0.1.4",
     "shiki-transformer-color-highlight": "^1.0.0",
     "tailwindcss": "^4.1.18",
-    "ufo": "^1.6.2",
+    "ufo": "^1.6.3",
     "zod": "^4.3.5"
   }
 }