@movk/nuxt-docs 1.16.1 → 1.16.3

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/app/components/DocsAsideRightBottom.vue

@@ -13,9 +13,9 @@ const showExplainWithAi = computed(() => {
 <template>
   <UButton
     v-if="showExplainWithAi"
-    :icon="aiChat.icons.explain"
+    :icon="aiChat.icons?.explain ?? ''"
     target="_blank"
-    :label="aiChat.texts.explainWithAi"
+    :label="aiChat.texts?.explainWithAi ?? ''"
     size="sm"
     variant="ghost"
     color="neutral"

package/app/components/header/Header.vue

@@ -4,7 +4,7 @@ import type { ButtonProps } from '@nuxt/ui'
 const route = useRoute()
 const { header, github } = useAppConfig()
 
-const links = computed<ButtonProps[]>(() => github && github.url
+const links = computed<ButtonProps[]>(() => (github && github.url
   ? [
       {
         'icon': 'i-simple-icons-github',
@@ -12,9 +12,9 @@ const links = computed<ButtonProps[]>(() => github && github.url
         'target': '_blank',
         'aria-label': 'GitHub'
       },
-      ...header?.links || []
+      ...(header?.links || [])
     ]
-  : header.links)
+  : header?.links || []) as ButtonProps[])
 </script>
 
 <template>

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

@@ -4,12 +4,12 @@ const { toggleChat } = useAIChat()
 </script>
 
 <template>
-  <UTooltip :text="aiChat.texts.trigger">
+  <UTooltip :text="aiChat.texts?.trigger ?? ''">
     <UButton
-      :icon="aiChat.icons.trigger"
+      :icon="aiChat.icons?.trigger ?? ''"
       variant="ghost"
       class="rounded-full"
-      :aria-label="aiChat.texts.trigger"
+      :aria-label="aiChat.texts?.trigger ?? ''"
       @click="toggleChat"
     />
   </UTooltip>

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

@@ -12,7 +12,7 @@ const inputRef = ref<{ inputRef: HTMLInputElement } | null>(null)
 
 const isDocsRoute = computed(() => route.meta.layout === 'docs')
 const isFloatingInputEnabled = computed(() => aiChat.floatingInput !== false)
-const focusInputShortcut = computed(() => aiChat.shortcuts.focusInput)
+const focusInputShortcut = computed(() => aiChat.shortcuts?.focusInput ?? 'meta_i')
 
 const shortcutDisplayKeys = computed(() => {
   const shortcut = focusInputShortcut.value
@@ -72,7 +72,7 @@ defineShortcuts(shortcuts)
           <UInput
             ref="inputRef"
             v-model="input"
-            :placeholder="aiChat.texts.placeholder"
+            :placeholder="aiChat.texts?.placeholder ?? ''"
             size="lg"
             maxlength="1000"
             :ui="{

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

@@ -159,30 +159,30 @@ const faqQuestions = computed<FaqCategory[]>(() => {
   <USidebar
     v-model:open="isOpen"
     side="right"
-    :title="aiChat.texts.title"
+    :title="aiChat.texts?.title ?? ''"
     rail
     :style="{ '--sidebar-width': '24rem' }"
     :ui="{ footer: 'p-0', actions: 'gap-0.5' }"
   >
     <template #actions>
-      <UTooltip v-if="canClear" :text="aiChat.texts.clearChat">
+      <UTooltip v-if="canClear" :text="aiChat.texts?.clearChat ?? ''">
         <UButton
-          :icon="aiChat.icons.clearChat"
+          :icon="aiChat.icons?.clearChat ?? ''"
           color="neutral"
           variant="ghost"
-          :aria-label="aiChat.texts.clearChat"
+          :aria-label="aiChat.texts?.clearChat ?? ''"
           @click="clearMessages"
         />
       </UTooltip>
     </template>
 
     <template #close>
-      <UTooltip :text="aiChat.texts.close">
+      <UTooltip :text="aiChat.texts?.close ?? ''">
         <UButton
-          :icon="aiChat.icons.close"
+          :icon="aiChat.icons?.close ?? ''"
           color="neutral"
           variant="ghost"
-          :aria-label="aiChat.texts.close"
+          :aria-label="aiChat.texts?.close ?? ''"
           @click="isOpen = false"
         />
       </UTooltip>
@@ -221,7 +221,7 @@ const faqQuestions = computed<FaqCategory[]>(() => {
               v-if="isReasoningUIPart(part)"
               :text="part.text"
               :streaming="isReasoningStreaming(message, index, chat)"
-              :icon="aiChat.icons.reasoning"
+              :icon="aiChat.icons?.reasoning ?? ''"
             >
               <MDCCached
                 :value="part.text"
@@ -262,7 +262,7 @@ const faqQuestions = computed<FaqCategory[]>(() => {
       <UChatPrompt
         v-model="input"
         :error="chat.error"
-        :placeholder="aiChat.texts.placeholder"
+        :placeholder="aiChat.texts?.placeholder ?? ''"
         variant="naked"
         size="sm"
         autofocus
@@ -275,7 +275,7 @@ const faqQuestions = computed<FaqCategory[]>(() => {
             <AiChatModelSelect v-model="model" />
 
             <div class="flex gap-1 justify-between items-center px-1 text-xs text-muted">
-              <span>{{ aiChat.texts.lineBreak }}</span>
+              <span>{{ aiChat.texts?.lineBreak ?? '' }}</span>
               <UKbd value="shift" />
               <UKbd value="enter" />
             </div>

package/modules/ai-chat/runtime/composables/useModels.ts

@@ -3,7 +3,7 @@ export function useModels() {
   const model = useCookie<string>('model', { default: () => config.public.aiChat.model })
 
   const { aiChat } = useAppConfig()
-  const providerIcons = computed(() => aiChat.icons.providers || {})
+  const providerIcons = computed(() => (aiChat.icons?.providers ?? {}) as Record<string, string>)
 
   function getModelIcon(modelId: string): string {
     const provider = modelId.split('/')[0] || ''

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,
@@ -198,5 +194,15 @@ export default defineNuxtConfig({
 
   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.1",
+  "version": "1.16.3",
   "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>",
@@ -71,6 +71,7 @@
     "nuxt-component-meta": "^0.17.2",
     "nuxt-llms": "^0.2.0",
     "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/api/github/commits.json.get.ts

@@ -32,9 +32,9 @@ export default defineCachedEventHandler(async (event) => {
   const allCommits = await Promise.all(
     paths.map(path =>
       octokit.rest.repos.listCommits({
-        sha: github.branch,
-        owner: github.owner,
-        repo: github.name,
+        sha: github.branch!,
+        owner: github.owner!,
+        repo: github.name!,
         path,
         since: github.since,
         per_page: github.per_page || 100,

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

@@ -29,9 +29,9 @@ export default defineCachedEventHandler(async (event) => {
 
   try {
     const commits = await octokit.rest.repos.listCommits({
-      sha: github.branch,
-      owner: github.owner,
-      repo: github.name,
+      sha: github.branch!,
+      owner: github.owner!,
+      repo: github.name!,
       path,
       per_page: 1
     }).then(res => res.data).catch(() => [])
@@ -58,8 +58,8 @@ export default defineCachedEventHandler(async (event) => {
         const prMatch = commit.commit.message.match(/#(\d+)/)
         if (prMatch?.[1]) {
           const prData = await octokit.rest.pulls.get({
-            owner: github.owner,
-            repo: github.name,
+            owner: github.owner!,
+            repo: github.name!,
             pull_number: Number.parseInt(prMatch[1])
           }).then(res => res.data).catch(() => null)
 

package/server/api/github/releases.json.get.ts

@@ -17,8 +17,8 @@ export default defineCachedEventHandler(async () => {
   const octokit = new Octokit({ auth: process.env.NUXT_GITHUB_TOKEN })
 
   const releases = await octokit.rest.repos.listReleases({
-    owner: github.owner,
-    repo: github.name
+    owner: github.owner!,
+    repo: github.name!
   }).then(res => res.data).catch(() => [])
 
   return releases

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
-      })
-    })
-  }
-})