docus 5.4.4 → 5.5.1

package/modules/markdown-rewrite.ts

@@ -0,0 +1,130 @@
+import { defineNuxtModule, logger } from '@nuxt/kit'
+import { resolve } from 'node:path'
+import { readFile, writeFile } from 'node:fs/promises'
+
+const log = logger.withTag('Docus')
+
+export default defineNuxtModule({
+  meta: {
+    name: 'markdown-rewrite',
+  },
+  setup(_options, nuxt) {
+    nuxt.hooks.hook('nitro:init', (nitro) => {
+      if (nitro.options.dev || !nitro.options.preset.includes('vercel')) {
+        return
+      }
+
+      nitro.hooks.hook('compiled', async () => {
+        const vcJSON = resolve(nitro.options.output.dir, 'config.json')
+        const vcConfig = JSON.parse(await readFile(vcJSON, 'utf8'))
+
+        // Check if llms.txt exists before setting up any routes
+        let llmsTxt
+        const llmsTxtPath = resolve(nitro.options.output.publicDir, 'llms.txt')
+        try {
+          llmsTxt = await readFile(llmsTxtPath, 'utf-8')
+        }
+        catch {
+          log.warn('llms.txt not found, skipping markdown redirect routes')
+          return
+        }
+
+        // Always redirect / to /llms.txt
+        const routes = [
+          {
+            src: '^/$',
+            dest: '/llms.txt',
+            has: [{ type: 'header', key: 'accept', value: '(.*)text/markdown(.*)' }],
+          },
+          {
+            src: '^/$',
+            dest: '/llms.txt',
+            has: [{ type: 'header', key: 'user-agent', value: 'curl/.*' }],
+          },
+        ]
+
+        // Check if i18n is enabled
+        const isI18nEnabled = !!(nuxt.options.i18n && nuxt.options.i18n.locales)
+        let localeCodes: string[] = []
+
+        if (isI18nEnabled) {
+          // Get locale codes
+          const locales = nuxt.options.i18n.locales || []
+          localeCodes = locales.map((locale) => {
+            return typeof locale === 'string' ? locale : locale.code
+          })
+
+          // Create a regex pattern for all locales (e.g., "en|fr|es")
+          const localePattern = localeCodes.join('|')
+
+          // Add routes for each locale homepage: /{locale} → /llms.txt
+          routes.push(
+            {
+              src: `^/(${localePattern})$`,
+              dest: '/llms.txt',
+              has: [{ type: 'header', key: 'accept', value: '(.*)text/markdown(.*)' }],
+            },
+            {
+              src: `^/(${localePattern})$`,
+              dest: '/llms.txt',
+              has: [{ type: 'header', key: 'user-agent', value: 'curl/.*' }],
+            },
+          )
+        }
+
+        // Parse llms.txt to get all documentation pages
+        const urlRegex = /\[([^\]]+)\]\((https?:\/\/[^)]+)\)/g
+        const matches = [...llmsTxt.matchAll(urlRegex)]
+
+        for (const match of matches) {
+          const url = match[2]
+          if (!url) continue
+
+          try {
+            // Extract path from URL
+            const urlObj = new URL(url)
+            const rawPath = urlObj.pathname
+
+            // Skip root path (already handled)
+            if (rawPath === '/') continue
+
+            // Only process raw markdown URLs from llms.txt
+            if (!rawPath.startsWith('/raw/')) continue
+
+            // Convert /raw/en/getting-started/installation.md to /en/getting-started/installation
+            const pagePath = rawPath.replace('/raw', '').replace(/\.md$/, '')
+
+            // Skip locale homepages (e.g., /en, /fr) - they already redirect to /llms.txt
+            if (isI18nEnabled) {
+              const isLocaleHomepage = localeCodes.some(code => pagePath === `/${code}`)
+              if (isLocaleHomepage) continue
+            }
+
+            // Add redirect routes: page URL → raw markdown URL
+            const docsRoutes = [
+              {
+                src: `^${pagePath}$`,
+                dest: rawPath,
+                has: [{ type: 'header', key: 'accept', value: '(.*)text/markdown(.*)' }],
+              },
+              {
+                src: `^${pagePath}$`,
+                dest: rawPath,
+                has: [{ type: 'header', key: 'user-agent', value: 'curl/.*' }],
+              },
+            ]
+            routes.push(...docsRoutes)
+          }
+          catch {
+            // Skip invalid URLs
+          }
+        }
+
+        vcConfig.routes.unshift(...routes)
+
+        await writeFile(vcJSON, JSON.stringify(vcConfig, null, 2), 'utf8')
+        log.info(`Successfully wrote ${routes.length} routes to ${vcJSON} (serve markdown content to AI agents)`)
+      })
+    })
+  },
+})

package/nuxt.config.ts

@@ -6,6 +6,7 @@ export default defineNuxtConfig({
   modules: [
     resolve('./modules/config'),
     resolve('./modules/routing'),
+    resolve('./modules/markdown-rewrite'),
     resolve('./modules/css'),
     '@nuxt/ui',
     '@nuxt/content',
@@ -19,9 +20,14 @@ export default defineNuxtConfig({
       extendViteConfig((config) => {
         config.optimizeDeps ||= {}
         config.optimizeDeps.include ||= []
-        config.optimizeDeps.include.push('@nuxt/content > slugify')
+        config.optimizeDeps.include.push(
+          '@nuxt/content > slugify',
+          // Fix @vercel/oidc ESM export issue (transitive dep of @ai-sdk/gateway)
+          '@vercel/oidc',
+        )
         config.optimizeDeps.include = config.optimizeDeps.include
           .map(id => id.replace(/^@nuxt\/content > /, 'docus > @nuxt/content > '))
+          .map(id => id.replace(/^@vercel\/oidc$/, 'docus > @vercel/oidc'))
       })
     },
   ],
@@ -44,6 +50,11 @@ export default defineNuxtConfig({
       },
     },
   },
+  mdc: {
+    highlight: {
+      shikiEngine: 'javascript',
+    },
+  },
   experimental: {
     asyncContext: true,
   },
@@ -76,9 +87,19 @@ export default defineNuxtConfig({
       nitroConfig.prerender = nitroConfig.prerender || {}
       nitroConfig.prerender.routes = nitroConfig.prerender.routes || []
       nitroConfig.prerender.routes.push(...(routes || []))
+      nitroConfig.prerender.routes.push('/sitemap.xml')
     },
   },
   icon: {
     provider: 'iconify',
   },
+  robots: {
+    groups: [
+      {
+        userAgent: '*',
+        allow: '/',
+      },
+    ],
+    sitemap: '/sitemap.xml',
+  },
 })

package/nuxt.schema.ts

@@ -214,5 +214,68 @@ export default defineNuxtSchema({
         }),
       },
     }),
+    assistant: group({
+      title: 'Assistant',
+      description: 'Assistant configuration.',
+      icon: 'i-lucide-sparkles',
+      fields: {
+        floatingInput: field({
+          type: 'boolean',
+          title: 'Floating Input',
+          description: 'Show the floating input at the bottom of documentation pages.',
+          icon: 'i-lucide-message-circle',
+          default: true,
+        }),
+        explainWithAi: field({
+          type: 'boolean',
+          title: 'Explain with AI',
+          description: 'Show the "Explain with AI" button in the documentation sidebar.',
+          icon: 'i-lucide-brain',
+          default: true,
+        }),
+        faqQuestions: field({
+          type: 'array',
+          title: 'FAQ Questions',
+          description: 'List of FAQ questions. Can be an array of strings or an array of categories with questions.',
+          icon: 'i-lucide-help-circle',
+          default: [],
+        }),
+        shortcuts: group({
+          title: 'Shortcuts',
+          description: 'Keyboard shortcuts configuration.',
+          icon: 'i-lucide-keyboard',
+          fields: {
+            focusInput: field({
+              type: 'string',
+              title: 'Focus Input',
+              description: 'Shortcut to focus the floating input (e.g., meta_i, ctrl_k).',
+              icon: 'i-lucide-keyboard',
+              default: 'meta_i',
+            }),
+          },
+        }),
+        icons: group({
+          title: 'Icons',
+          description: 'Icons configuration.',
+          icon: 'i-lucide-settings',
+          fields: {
+            trigger: field({
+              type: 'icon',
+              title: 'Trigger',
+              description: 'Icon for the AI chat trigger button and slideover header.',
+              icon: 'i-lucide-sparkles',
+              default: 'i-lucide-sparkles',
+            }),
+            explain: field({
+              type: 'icon',
+              title: 'Explain',
+              description: 'Icon for the "Explain with AI" button.',
+              icon: 'i-lucide-brain',
+              default: 'i-lucide-brain',
+            }),
+          },
+        }),
+      },
+    }),
   },
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docus",
   "description": "Nuxt layer for Docus documentation theme",
-  "version": "5.4.4",
+  "version": "5.5.1",
   "type": "module",
   "main": "./nuxt.config.ts",
   "repository": {
@@ -22,30 +22,39 @@
     "README.md"
   ],
   "dependencies": {
-    "@iconify-json/lucide": "^1.2.86",
-    "@iconify-json/simple-icons": "^1.2.67",
-    "@iconify-json/vscode-icons": "^1.2.40",
-    "@nuxt/content": "^3.11.0",
+    "@ai-sdk/gateway": "^3.0.39",
+    "@ai-sdk/mcp": "^1.0.19",
+    "@ai-sdk/vue": "3.0.78",
+    "@iconify-json/lucide": "^1.2.90",
+    "@iconify-json/simple-icons": "^1.2.70",
+    "@iconify-json/vscode-icons": "^1.2.41",
+    "@nuxt/content": "^3.11.2",
     "@nuxt/image": "^2.0.0",
-    "@nuxt/kit": "^4.2.2",
-    "@nuxt/ui": "^4.3.0",
-    "@nuxtjs/i18n": "^10.2.1",
-    "@nuxtjs/mcp-toolkit": "^0.6.2",
-    "@nuxtjs/mdc": "^0.20.0",
-    "@nuxtjs/robots": "^5.6.7",
-    "@vueuse/core": "^14.1.0",
+    "@nuxt/kit": "^4.3.1",
+    "@nuxt/ui": "^4.4.0",
+    "@nuxtjs/i18n": "^10.2.3",
+    "@nuxtjs/mcp-toolkit": "^0.6.3",
+    "@nuxtjs/mdc": "^0.20.1",
+    "@nuxtjs/robots": "^5.7.0",
+    "@vueuse/core": "^14.2.1",
+    "ai": "6.0.78",
     "defu": "^6.1.4",
     "exsolve": "^1.0.8",
     "git-url-parse": "^16.1.0",
-    "minimark": "^0.2.0",
-    "motion-v": "^1.9.0",
+    "minimark": "^1.0.0",
+    "motion-v": "^1.10.3",
     "nuxt-llms": "^0.2.0",
     "nuxt-og-image": "^5.1.13",
     "pkg-types": "^2.3.0",
     "scule": "^1.3.0",
+    "@shikijs/core": "^3.22.0",
+    "@shikijs/engine-javascript": "^3.22.0",
+    "@shikijs/langs": "^3.22.0",
+    "@shikijs/themes": "^3.22.0",
+    "shiki-stream": "^0.1.4",
     "tailwindcss": "^4.1.18",
     "ufo": "^1.6.3",
-    "zod": "^4.3.5",
+    "zod": "^4.3.6",
     "zod-to-json-schema": "^3.25.1"
   },
   "peerDependencies": {

package/server/routes/sitemap.xml.ts

@@ -0,0 +1,93 @@
+import { queryCollection } from '@nuxt/content/server'
+import { getAvailableLocales, getCollectionsToQuery } from '../utils/content'
+import { inferSiteURL } from '../../utils/meta'
+
+interface SitemapUrl {
+  loc: string
+  lastmod?: string
+}
+
+export default defineEventHandler(async (event) => {
+  const config = useRuntimeConfig(event)
+  const siteUrl = inferSiteURL() || ''
+
+  const availableLocales = getAvailableLocales(config.public as Record<string, unknown>)
+  const collections = getCollectionsToQuery(undefined, availableLocales)
+
+  if (availableLocales.length > 0) {
+    for (const locale of availableLocales) {
+      collections.push(`landing_${locale}`)
+    }
+  }
+  else {
+    collections.push('landing')
+  }
+
+  const urls: SitemapUrl[] = []
+
+  for (const collection of collections) {
+    try {
+      const pages = await queryCollection(event, collection as 'docs').all()
+
+      for (const page of pages) {
+        const meta = page as unknown as Record<string, unknown>
+        const pagePath = (page.path as string) || '/'
+
+        // Skip pages with sitemap: false in frontmatter
+        if (meta.sitemap === false) continue
+
+        // Skip .navigation files (used for navigation configuration)
+        if (pagePath.endsWith('.navigation') || pagePath.includes('/.navigation')) continue
+
+        const urlEntry: SitemapUrl = {
+          loc: pagePath,
+        }
+
+        // Add lastmod if available (modifiedAt from content)
+        if (meta.modifiedAt && typeof meta.modifiedAt === 'string') {
+          urlEntry.lastmod = meta.modifiedAt.split('T')[0] // Use date part only (YYYY-MM-DD)
+        }
+
+        urls.push(urlEntry)
+      }
+    }
+    catch {
+      // Collection might not exist, skip it
+    }
+  }
+
+  const sitemap = generateSitemap(urls, siteUrl)
+
+  setResponseHeader(event, 'content-type', 'application/xml')
+  return sitemap
+})
+
+function generateSitemap(urls: SitemapUrl[], siteUrl: string): string {
+  const urlEntries = urls
+    .map((url) => {
+      const loc = siteUrl ? `${siteUrl}${url.loc}` : url.loc
+      let entry = `  <url>\n    <loc>${escapeXml(loc)}</loc>`
+
+      if (url.lastmod) {
+        entry += `\n    <lastmod>${escapeXml(url.lastmod)}</lastmod>`
+      }
+
+      entry += `\n  </url>`
+      return entry
+    })
+    .join('\n')
+
+  return `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+${urlEntries}
+</urlset>`
+}
+
+function escapeXml(str: string): string {
+  return str
+    .replace(/&/g, '&amp;')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;')
+    .replace(/"/g, '&quot;')
+    .replace(/'/g, '&apos;')
+}

package/utils/meta.ts

@@ -1,15 +1,21 @@
 import { readFile } from 'node:fs/promises'
 import { resolve } from 'node:path'
+import { withHttps } from 'ufo'
 
 export function inferSiteURL() {
   // https://github.com/unjs/std-env/issues/59
-  return (
-    process.env.NUXT_SITE_URL
-    || (process.env.NEXT_PUBLIC_VERCEL_URL && `https://${process.env.NEXT_PUBLIC_VERCEL_URL}`) // Vercel
+  const url = (
+    process.env.NUXT_PUBLIC_SITE_URL // Nuxt public runtime config
+    || process.env.NUXT_SITE_URL // Nuxt site config
+    || process.env.VERCEL_PROJECT_PRODUCTION_URL // Vercel production URL
+    || process.env.VERCEL_BRANCH_URL // Vercel branch URL
+    || process.env.VERCEL_URL // Vercel deployment URL
     || process.env.URL // Netlify
     || process.env.CI_PAGES_URL // Gitlab Pages
     || process.env.CF_PAGES_URL // Cloudflare Pages
   )
+
+  return url ? withHttps(url) : undefined
 }
 
 export async function getPackageJsonMetadata(dir: string) {