FAQ

Answers to common questions about Movk Nuxt Docs, from how it relates to the Nuxt UI docs template, package managers and Node.js versions, and single-language sites, to turning off GitHub, using other AI providers, upgrading, overriding components and static hosting limits.
View source

How does it relate to the Nuxt UI docs template?

Movk Nuxt Docs grew out of the Nuxt UI docs site and the UI docs template, and ships as a Nuxt Layer named @movk/nuxt-docs. On top of that it adds generated component docs, AI Chat, an MCP Server, Agent Skills, multiple languages and an editorial theme, and it regularly syncs upstream changes. You only add extends: ['@movk/nuxt-docs'] to nuxt.config.ts instead of copying template code. See the Introduction.

Do I have to use pnpm?

No. pnpm, npm, yarn and bun all work. The environment requirements are Nuxt 4.6.1+ (4.x) and Node.js 22.22.3+ (22.x), 24.15.0+ (24.x), or 26+. Nuxt Content relies on the built-in node:sqlite. With pnpm, allow the sharp build script in pnpm-workspace.yaml; see Troubleshooting.

Can I skip @nuxtjs/i18n if I only need one language?

Yes, that is the default. Without i18n configured, the site runs in a single language with no locale prefix in URLs; switch the UI language with i18n.locale in app.config. See Internationalization.

Do docs have to live in content/docs?

Yes. Docs always live in content/docs/ and are served under /docs; other locales go in content/{code}/docs/. The home page comes from content/index.md, or from your own page when app/pages/index.vue exists. See Project Structure.

How do I turn off the GitHub integration?

Set github to false in app.config.ts. Edit links, view source and commit history are all hidden:

app/app.config.ts
export default defineAppConfig({
  github: false
})

When you keep it, the layer infers the repository from Git, and production needs NUXT_GITHUB_TOKEN. See Configuration.

Can I use model providers other than OpenAI?

Yes. Set AI_BASE_URL to connect directly to any OpenAI-compatible endpoint (such as DeepSeek or Qwen); without it, provider/model model ids go through the Vercel AI Gateway. For a provider that is not OpenAI-compatible, register its AI SDK provider with modelProviderRegistry.register() in server/plugins/. See AI Chat.

What if I do not want AI Chat?

Leave AI_API_KEY unset. AI Chat is off by default and its dependencies are not bundled. If AI_API_KEY exists in the build environment but you do not want AI Chat, set aiChat.enabled: false. See Feature Flags.

How do I upgrade the layer?

Bump @movk/nuxt-docs and reinstall:

pnpm add @movk/nuxt-docs@latest

When moving from v2 to v3, read the Migration Guide first; it lists every breaking change. Changes in each version are on the Releases page.

Create a component with the same name in your project's app/components/ to override the layer's implementation, for example app/components/HeaderLogo.vue. Only the components listed in the override contract keep their name, mount point and props stable across v3.x; the rest are internal. If you only need different navigation links, use header.nav in app.config instead; see Navigation & Categories.

How do I change the primary color or fonts?

The default primary color is vermilion, the neutral is paper (a warm gray), and headings use a serif font. Change the primary color with ui.colors in app.config, and switch headings to sans-serif everywhere with theme.font. See Theme & Fonts.

Can I deploy it as a static site?

Yes. Run nuxt generate and deploy .output/public/ to any static host. Pages, search, component docs and OG images all work, but AI Chat, the MCP Server, commit history and Markdown content negotiation need a server and are unavailable on a static site. See Deployment.

How do AI agents read my docs?

The layer provides llms.txt, an MCP Server and Markdown content negotiation out of the box: agents requesting a page can get Markdown directly, and /raw/**.md serves a Markdown version of every page. See llms.txt, MCP Server and Agent Discovery.

What if builds are slow or run out of memory?

Turning off features you do not need cuts build work noticeably; for example movkNuxtDocs.ogImage: false skips rendering an OG image for every page.

Copyright © 2024 - 2026