docus 5.10.1 → 5.11.0

package/app/app.config.ts

@@ -17,7 +17,7 @@ export default defineAppConfig({
     },
     contentToc: {
       defaultVariants: {
-        highlight: true,
+        highlightVariant: 'circuit',
       },
     },
     contentNavigation: {

package/app/components/docs/DocsPageHeaderLinks.vue

@@ -1,15 +1,20 @@
 <script setup lang="ts">
 import { useClipboard } from '@vueuse/core'
+import { joinURL, withTrailingSlash } from 'ufo'
 import { useRuntimeConfig } from '#imports'
 
 const route = useRoute()
 const toast = useToast()
-const appBaseURL = useRuntimeConfig().app?.baseURL || '/'
+const runtimeConfig = useRuntimeConfig()
+const appBaseURL = runtimeConfig.app?.baseURL || '/'
+const mcpRoute = (runtimeConfig.public.mcp as { route?: string } | undefined)?.route || '/mcp'
 
 const { copy, copied } = useClipboard()
 const { t } = useDocusI18n()
 
-const markdownLink = computed(() => `${window?.location?.origin}${appBaseURL}raw${route.path}.md`)
+const markdownLink = computed(() => `${window?.location?.origin}${withTrailingSlash(appBaseURL)}raw${route.path}.md`)
+const mcpServerUrl = computed(() => `${window?.location?.origin}${joinURL(appBaseURL, mcpRoute)}`)
+const mcpDeeplink = joinURL(mcpRoute, 'deeplink')
 const items = [
   [{
     label: t('docs.copy.link'),
@@ -41,7 +46,7 @@ const items = [
       label: 'Copy MCP Server URL',
       icon: 'i-lucide-link',
       onSelect() {
-        copy(`${window?.location?.origin}${appBaseURL}mcp`)
+        copy(mcpServerUrl.value)
         toast.add({
           title: 'Copied to clipboard',
           icon: 'i-lucide-check-circle',
@@ -52,7 +57,7 @@ const items = [
       label: 'Add MCP Server',
       icon: 'i-simple-icons:cursor',
       target: '_blank',
-      to: `/mcp/deeplink`,
+      to: mcpDeeplink,
     },
   ],
 ]

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

@@ -76,6 +76,7 @@ addPrerenderPath(`/raw${route.path}.md`)
   <UPage
     v-if="page"
     :key="`page-${shouldHideToc}`"
+    :ui="{ root: 'lg:grid-cols-12', center: 'lg:col-span-9', right: 'lg:col-span-3' }"
   >
     <UPageHeader
       :title="page.title"

package/app/plugins/i18n.ts

@@ -1,7 +1,7 @@
 import type { RouteLocationNormalized } from 'vue-router'
 import { consola } from 'consola'
 
-const log = consola.withTag('Docus')
+const log = consola.withTag('docus')
 
 // Lazy import functions for locale files (bundled but not eagerly loaded)
 const localeFiles = import.meta.glob<{ default: Record<string, unknown> }>('../../i18n/locales/*.json')

package/modules/assistant/index.ts

@@ -21,7 +21,7 @@ export interface AssistantModuleOptions {
   model?: string
 }
 
-const log = logger.withTag('Docus')
+const log = logger.withTag('docus')
 
 const defaults: Required<AssistantModuleOptions> = {
   apiPath: '/__docus__/assistant',
@@ -77,7 +77,9 @@ export default defineNuxtModule<AssistantModuleOptions>({
     )
 
     if (!hasAiGatewayAuth) {
-      log.warn('AI assistant disabled: neither AI_GATEWAY_API_KEY nor VERCEL_OIDC_TOKEN found')
+      nuxt.hook('modules:done', () => {
+        log.warn('AI assistant disabled: neither `AI_GATEWAY_API_KEY` nor `VERCEL_OIDC_TOKEN` found')
+      })
       return
     }
 

package/modules/config.ts

@@ -5,10 +5,11 @@ import { join } from 'node:path'
 import { inferSiteURL, getPackageJsonMetadata } from '../utils/meta'
 import { getGitBranch, getGitEnv, getLocalGitInfo } from '../utils/git'
 
-const log = logger.withTag('Docus')
+const log = logger.withTag('docus')
 
 type I18nLocale = string | { code: string, name?: string }
 type DocusI18nOptions = { locales?: I18nLocale[], strategy?: string }
+type DocusMcpOptions = { route?: string, enabled?: boolean }
 type RegisterModuleOptions = {
   langDir: string
   locales: Array<{ code: string, name: string, file: string }>
@@ -58,6 +59,16 @@ export default defineNuxtModule({
       branch: getGitBranch(),
     })
 
+    /*
+    ** MCP route (expose to client so the page header dropdown stays in sync
+    ** with the user-configured `mcp.route` from @nuxtjs/mcp-toolkit)
+    */
+    const mcpOptions = (nuxt.options as typeof nuxt.options & { mcp?: DocusMcpOptions }).mcp
+    nuxt.options.runtimeConfig.public.mcp = defu(
+      nuxt.options.runtimeConfig.public.mcp as DocusMcpOptions | undefined,
+      { route: mcpOptions?.route || '/mcp' },
+    )
+
     const forcedColorMode = (nuxt.options.appConfig.docus as Record<string, unknown>)?.colorMode as string | undefined
     if (forcedColorMode === 'light' || forcedColorMode === 'dark') {
       nuxt.options.colorMode = defu({ preference: forcedColorMode, fallback: forcedColorMode }, nuxt.options.colorMode || {}) as typeof nuxt.options.colorMode

package/modules/css.ts

@@ -1,21 +1,37 @@
-import { defineNuxtModule, addTemplate, createResolver } from '@nuxt/kit'
-import { joinURL } from 'ufo'
+import { defineNuxtModule, addTemplate, createResolver, logger } from '@nuxt/kit'
+import { existsSync } from 'node:fs'
+import { readFile } from 'node:fs/promises'
+import { resolve } from 'pathe'
 import { resolveModulePath } from 'exsolve'
 
+const log = logger.withTag('docus')
+
 export default defineNuxtModule({
   meta: {
-    name: 'css',
+    name: 'docus-css',
   },
   async setup(_options, nuxt) {
-    const dir = nuxt.options.rootDir
     const resolver = createResolver(import.meta.url)
 
-    const contentDir = joinURL(dir, 'content')
+    const contentDir = resolve(nuxt.options.rootDir, 'content')
     const uiPath = resolveModulePath('@nuxt/ui', { from: import.meta.url, conditions: ['style'] })
     const tailwindPath = resolveModulePath('tailwindcss', { from: import.meta.url, conditions: ['style'] })
     const layerDir = resolver.resolve('../app')
     const assistantDir = resolver.resolve('../modules/assistant')
 
+    let userDocusPath: string | null = resolve(nuxt.options.srcDir, 'app.css')
+    if (existsSync(userDocusPath)) {
+      const userDocusCss = await readFile(userDocusPath, 'utf-8')
+      if (userDocusCss.includes('@import "tailwindcss"')) {
+        nuxt.hook('modules:done', () => {
+          log.warn('`app.css` contains `@import "tailwindcss";` consider removing it to avoid duplicate css.')
+        })
+      }
+    }
+    else {
+      userDocusPath = null
+    }
+
     const cssTemplate = addTemplate({
       filename: 'docus.css',
       getContents: () => {
@@ -25,7 +41,12 @@ export default defineNuxtModule({
 @source "${contentDir.replace(/\\/g, '/')}/**/*";
 @source "${layerDir.replace(/\\/g, '/')}/**/*";
 @source "../../app.config.ts";
-@source "${assistantDir.replace(/\\/g, '/')}/**/*";`
+@source "${assistantDir.replace(/\\/g, '/')}/**/*";
+
+:root {
+  --ui-container: 90rem;
+}
+` + (userDocusPath ? `\n@import ${JSON.stringify(userDocusPath)};` : '')
       },
     })
 

package/modules/markdown-rewrite.ts

@@ -2,7 +2,7 @@ import { defineNuxtModule, logger } from '@nuxt/kit'
 import { resolve } from 'node:path'
 import { readFile, writeFile } from 'node:fs/promises'
 
-const log = logger.withTag('Docus')
+const log = logger.withTag('docus')
 
 type I18nLocale = string | { code: string }
 type DocusI18nOptions = { locales?: I18nLocale[] }

package/modules/skills/index.ts

@@ -19,7 +19,7 @@ export interface SkillsModuleOptions {
 const SKILL_NAME_REGEX = /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/
 const MAX_NAME_LENGTH = 64
 
-const log = logger.withTag('Docus')
+const log = logger.withTag('docus')
 
 const defaults: Required<SkillsModuleOptions> = {
   dir: 'skills',
@@ -38,7 +38,9 @@ export default defineNuxtModule<SkillsModuleOptions>({
     const catalog = await scanSkills(skillsDir)
     if (!catalog.length) return
 
-    log.info(`Found ${catalog.length} agent skill${catalog.length > 1 ? 's' : ''}: ${catalog.map(s => s.name).join(', ')}`)
+    nuxt.hook('modules:done', () => {
+      log.info(`Found ${catalog.length} agent skill${catalog.length > 1 ? 's' : ''}: ${catalog.map(s => s.name).join(', ')}`)
+    })
 
     nuxt.options.runtimeConfig.skills = { catalog }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docus",
   "description": "Nuxt layer for Docus documentation theme",
-  "version": "5.10.1",
+  "version": "5.11.0",
   "type": "module",
   "main": "./nuxt.config.ts",
   "repository": {
@@ -50,6 +50,7 @@
     "motion-v": "^2.2.1",
     "nuxt-llms": "^0.2.0",
     "nuxt-og-image": "^6.4.5",
+    "pathe": "^2.0.3",
     "pkg-types": "^2.3.0",
     "scule": "^1.3.0",
     "shiki-stream": "^0.1.4",

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

@@ -1,4 +1,5 @@
 import { z } from 'zod'
+import { joinURL } from 'ufo'
 import { queryCollection } from '@nuxt/content/server'
 import type { Collections } from '@nuxt/content'
 import { getAvailableLocales, getCollectionFromPath } from '../../utils/content'
@@ -33,11 +34,13 @@ WORKFLOW: This tool returns the complete page content including title, descripti
   cache: '1h',
   handler: async ({ path }) => {
     const event = useEvent()
-    const config = useRuntimeConfig(event).public
+    const config = useRuntimeConfig(event)
+    const publicConfig = config.public
     const siteUrl = getRequestURL(event).origin || inferSiteURL()
+    const baseURL = config.app?.baseURL || '/'
 
-    const availableLocales = getAvailableLocales(config)
-    const collectionName = config.i18n?.locales
+    const availableLocales = getAvailableLocales(publicConfig)
+    const collectionName = publicConfig.i18n?.locales
       ? getCollectionFromPath(path, availableLocales)
       : 'docs'
 
@@ -58,7 +61,7 @@ WORKFLOW: This tool returns the complete page content including title, descripti
         path: page.path,
         description: page.description,
         content,
-        url: `${siteUrl}${page.path}`,
+        url: siteUrl ? joinURL(siteUrl, baseURL, page.path) : joinURL(baseURL, page.path),
       }
     }
     catch (error) {

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

@@ -1,4 +1,5 @@
 import { z } from 'zod'
+import { joinURL } from 'ufo'
 import { queryCollection } from '@nuxt/content/server'
 import type { Collections } from '@nuxt/content'
 import { getCollectionsToQuery, getAvailableLocales } from '../../utils/content'
@@ -39,10 +40,12 @@ OUTPUT: Returns a structured list with:
   cache: '1h',
   handler: async ({ locale }) => {
     const event = useEvent()
-    const config = useRuntimeConfig(event).public
+    const config = useRuntimeConfig(event)
+    const publicConfig = config.public
 
     const siteUrl = getRequestURL(event).origin || inferSiteURL()
-    const availableLocales = getAvailableLocales(config)
+    const baseURL = config.app?.baseURL || '/'
+    const availableLocales = getAvailableLocales(publicConfig)
     const collections = getCollectionsToQuery(locale, availableLocales)
 
     try {
@@ -57,7 +60,7 @@ OUTPUT: Returns a structured list with:
             path: page.path,
             description: page.description,
             locale: collectionName.replace('docs_', ''),
-            url: `${siteUrl}${page.path}`,
+            url: siteUrl ? joinURL(siteUrl, baseURL, page.path) : joinURL(baseURL, page.path),
           }))
         }),
       )