nuxt.config Options

Every nuxt.config option and environment variable the layer reads at build time, including feature flags, AI Chat, component metadata, MCP, llms.txt, agent discovery and site info. Changing these options requires a rebuild or a dev server restart.
View source

This page lists the options Movk Nuxt Docs reads or presets in nuxt.config.ts. For runtime UI settings, see the app.config Reference.

nuxt.config.ts
export default defineNuxtConfig({
  extends: ['@movk/nuxt-docs'],
  site: { name: 'My Docs', url: 'https://docs.example.com' },
  movkNuxtDocs: { componentDocs: true },
  aiChat: { model: 'openai/gpt-5-mini' }
})

movkNuxtDocs

Feature flags, see Feature Flags.

OptionTypeDefaultDescription
movkNuxtDocs.componentDocsbooleanfalseComponent docs: ComponentProps / Slots / Emits / Code / Example; requires nuxt-component-meta, vue-component-meta and prettier
movkNuxtDocs.mcpbooleantrueBuilt-in MCP Server; cannot be turned off while AI Chat is enabled
movkNuxtDocs.ogImagebooleantrueOG images generated at build time
movkNuxtDocs.mermaidbooleanfalseMermaid diagrams; requires mermaid and dompurify
movkNuxtDocs.a11ybooleanfalse@nuxt/a11y accessibility checks during development; requires @nuxt/a11y

aiChat

Module options of the AI chat assistant. UI text and icons live in aiChat in app.config, see AI Chat.

OptionTypeDefaultDescription
aiChat.enabledbooleantrue when AI_API_KEY exists at build timeEnable AI Chat
aiChat.modelstring''Default model, as provider/model or model
aiChat.modelsstring[][]Models offered in the model selector
aiChat.apiPathstring'/api/ai-chat'Chat API endpoint; a handler at the same path in your server/ directory replaces the built-in one
aiChat.mcpPathstring'/mcp'MCP Server path AI Chat connects to, also written to the MCP server card

componentMeta

Options passed to nuxt-component-meta when movkNuxtDocs.componentDocs is on. The layer excludes every component under your app/components/ and components/ by default; only components matched by include get metadata.

OptionTypeDefaultDescription
componentMeta.includeArray<string | RegExp | (component) => boolean>[]Project components to generate metadata for. Strings match the file path and support * (within a directory) and **; regular expressions match both the file path and the PascalCase name; functions receive { filePath, pascalName }
componentMeta.excludeSame as aboveOfficial Nuxt packages and modules that register components by package nameExtra exclusions, appended after the layer defaults
nuxt.config.ts
export default defineNuxtConfig({
  componentMeta: {
    include: [
      'app/components/ui/**',
      /^Base/,
      ({ pascalName }) => pascalName.endsWith('Input')
    ]
  }
})

site

Read by nuxt-site-config; affects canonical URLs, the sitemap, OG images, llms.txt and the MCP server card.

OptionTypeDefaultDescription
site.urlstringInferred from the deployment environmentSite URL, read from NUXT_PUBLIC_SITE_URL, NUXT_SITE_URL, then the deployment URLs of Vercel, Netlify, Cloudflare Pages and GitLab Pages
site.namestringname in package.json, then the Git repository nameSite name, also the default of header.title, seo.title and llms.title

mcp

Options passed to @nuxtjs/mcp-toolkit when movkNuxtDocs.mcp is on; see that module's docs for options not listed here, and MCP Server.

OptionTypeDefaultDescription
mcp.namestringDecided by @nuxtjs/mcp-toolkitName of the MCP Server
mcp.browserRedirectstringDecided by @nuxtjs/mcp-toolkitPage to redirect to when the MCP endpoint is opened in a browser; also the documentation URL of the MCP server card, which uses /docs when unset

llms

Options passed to nuxt-llms to generate /llms.txt and /llms-full.txt, see LLMs.txt.

OptionTypeDefaultDescription
llms.domainstringInferred site URL, or https://example.com when it cannot be inferredDomain used for links in the files
llms.titlestringSite nameTitle of /llms.txt
llms.descriptionstringdescription in package.jsonDescription of /llms.txt
llms.full.titlestringSite nameTitle of /llms-full.txt
llms.full.descriptionstringdescription in package.jsonDescription of /llms-full.txt
llms.notesstring[]—Notes appended to /llms.txt

agentDiscovery

Options passed to nuxt-agent-discovery. The layer presets the values below, see Agent Discovery.

OptionTypeDefaultDescription
agentDiscovery.skills.dirstring'skills'Agent Skills directory, relative to the project root, see Agent Skills
agentDiscovery.sitemap.markdown.expandstring[]['/docs']Paths whose child pages are all listed in /sitemap.md
agentDiscovery.sitemap.markdown.labelsRecord<string, string>{ 'getting-started': 'Getting Started' }Replacement titles for sections in /sitemap.md
agentDiscovery.siteUrl / siteNamestringsite.url / site.nameSite info used in discovery documents

The MCP server card and discovery links are generated by the layer from the feature flags, aiChat.mcpPath and mcp.browserRedirect; overriding them by hand is not recommended.

i18n

Add @nuxtjs/i18n to modules and configure i18n.locales to enable multiple languages, see Internationalization.

OptionTypeDescription
i18n.defaultLocalestringDefault locale, served without a URL prefix; defaults to the first entry of locales
i18n.localesArray<{ code: string, name: string }>Locales. Locales without a built-in translation file or a content/{code}/docs directory are filtered out at build time with a warning; do not declare file

The layer always uses the prefix_except_default routing strategy.

Environment variables

VariableRequiredDescription
NUXT_GITHUB_TOKENRecommended in productionGitHub API token for the releases page, commit history and last commit dates, avoiding anonymous rate limits
AI_API_KEYWhen AI Chat is enabledMaster switch for AI Chat; shared by AI Gateway and OpenAI-compatible endpoints
AI_BASE_URLNoOpenAI-compatible endpoint such as https://api.deepseek.com/v1; AI Gateway is used when empty
NUXT_PUBLIC_SITE_URL / NUXT_SITE_URLNoExplicit site URL, taking precedence over platform inference
Copyright © 2024 - 2026