Nuxt llms.txt

The actual file

Source Markdown

The saved llms.txt text, displayed as source. The file belongs to its publisher; the live endpoint may change.

Showing the first 18000 characters. Load the complete file to read the remainder.

# Nuxt Docs

> Nuxt is an open source framework that makes web development intuitive and powerful. Create performant and production-grade full-stack web apps and websites with confidence.

Every documentation, blog and deploy page is also Markdown. Append `.md` to a URL, or send `Accept: text/markdown` on the HTML one. <https://nuxt.com/llms-full.txt> is the whole documentation in a single file, and <https://nuxt.com/sitemap.md> lists every page.

For search and structured lookups, call the MCP server at <https://nuxt.com/mcp> (streamable HTTP), described by <https://nuxt.com/.well-known/mcp/server-card.json>. The REST endpoints under `/api/v1` are public, read-only and need no credentials: the module directory, its health data, and the core and ecosystem teams. <https://nuxt.com/openapi.json> describes them.

## When to use this

Use these docs when you are writing, reviewing or debugging code for a Nuxt application: scaffolding a project, configuring `nuxt.config.ts`, picking a rendering mode per route, writing pages, layouts, components, composables, server routes, middleware and plugins, fetching data with `useFetch` and `useAsyncData`, adding or authoring a module, upgrading between major versions, and deploying to a specific provider.

They cover Nuxt itself. For Vue, Vite, Nitro or UnJS APIs, go to their own documentation, and for questions about a specific module, to the module's own docs, which the directory links.

- [Nuxt](https://nuxt.com/raw/index.md)

## Documentation Sets

- [Nuxt Docs](https://nuxt.com/llms-full.txt): The complete Nuxt documentation and blog posts written in Markdown (MDC syntax).

## Nuxt v4 Documentation

The current stable release. Other versions live under /docs/<version> and are listed in full in /llms-full.txt.

- [Introduction](https://nuxt.com/raw/docs/4.x/getting-started/introduction.md): Nuxt's goal is to make web development intuitive and performant with a great Developer Experience in mind.
- [Installation](https://nuxt.com/raw/docs/4.x/getting-started/installation.md): Get started with Nuxt quickly with our online starters or start locally with your terminal.
- [Configuration](https://nuxt.com/raw/docs/4.x/getting-started/configuration.md): Nuxt is configured with sensible defaults to make you productive.
- [Views](https://nuxt.com/raw/docs/4.x/getting-started/views.md): Nuxt provides several component layers to implement the user interface of your application.
- [Assets](https://nuxt.com/raw/docs/4.x/getting-started/assets.md): Nuxt offers two options for your assets.
- [Styling](https://nuxt.com/raw/docs/4.x/getting-started/styling.md): Learn how to style your Nuxt application.
- [Routing](https://nuxt.com/raw/docs/4.x/getting-started/routing.md): Nuxt file-system routing creates a route for every file in the pages/ directory.
- [SEO and Meta](https://nuxt.com/raw/docs/4.x/getting-started/seo-meta.md): Improve your Nuxt app's SEO with powerful head config, composables and components.
- [Transitions](https://nuxt.com/raw/docs/4.x/getting-started/transitions.md): Apply transitions between pages and layouts with Vue or native browser View Transitions.
- [Data Fetching](https://nuxt.com/raw/docs/4.x/getting-started/data-fetching.md): Nuxt provides composables to handle data fetching within your application.
- [State Management](https://nuxt.com/raw/docs/4.x/getting-started/state-management.md): Nuxt provides powerful state management libraries and the useState composable to create a reactive and SSR-friendly shared state.
- [Error Handling](https://nuxt.com/raw/docs/4.x/getting-started/error-handling.md): Learn how to catch and handle errors in Nuxt.
- [Server](https://nuxt.com/raw/docs/4.x/getting-started/server.md): Build full-stack applications with Nuxt's server framework. You can fetch data from your database or another server, create APIs, or even generate static server-side content like a sitemap or a RSS feed - all from a single codebase.
- [Layers](https://nuxt.com/raw/docs/4.x/getting-started/layers.md): Nuxt provides a powerful system that allows you to extend the default files, configs, and much more.
- [Prerendering](https://nuxt.com/raw/docs/4.x/getting-started/prerendering.md): Nuxt allows pages to be statically rendered at build time to improve certain performance or SEO metrics
- [Deployment](https://nuxt.com/raw/docs/4.x/getting-started/deployment.md): Learn how to deploy your Nuxt application to any hosting provider.
- [Testing](https://nuxt.com/raw/docs/4.x/getting-started/testing.md): How to test your Nuxt application.
- [Upgrade Guide](https://nuxt.com/raw/docs/4.x/getting-started/upgrade.md): Learn how to upgrade to the latest Nuxt version.
- [.nuxt](https://nuxt.com/raw/docs/4.x/directory-structure/nuxt.md): Nuxt uses the .nuxt/ directory in development to generate your Vue application.
- [.output](https://nuxt.com/raw/docs/4.x/directory-structure/output.md): Nuxt creates the .output/ directory when building your application for production.
- [assets](https://nuxt.com/raw/docs/4.x/directory-structure/app/assets.md): The assets/ directory is used to add all the website's assets that the build tool will process.
- [components](https://nuxt.com/raw/docs/4.x/directory-structure/app/components.md): The components/ directory is where you put all your Vue components.
- [composables](https://nuxt.com/raw/docs/4.x/directory-structure/app/composables.md): Use the composables/ directory to auto-import your Vue composables into your application.
- [layouts](https://nuxt.com/raw/docs/4.x/directory-structure/app/layouts.md): Nuxt provides a layouts framework to extract common UI patterns into reusable layouts.
- [middleware](https://nuxt.com/raw/docs/4.x/directory-structure/app/middleware.md): Nuxt provides middleware to run code before navigating to a particular route.
- [pages](https://nuxt.com/raw/docs/4.x/directory-structure/app/pages.md): Nuxt provides file-based routing to create routes within your web application.
- [plugins](https://nuxt.com/raw/docs/4.x/directory-structure/app/plugins.md): Nuxt has a plugins system to use Vue plugins and more at the creation of your Vue application.
- [utils](https://nuxt.com/raw/docs/4.x/directory-structure/app/utils.md): Use the utils/ directory to auto-import your utility functions throughout your application.
- [app.vue](https://nuxt.com/raw/docs/4.x/directory-structure/app/app.md): The app.vue file is the main component of your Nuxt application.
- [app.config.ts](https://nuxt.com/raw/docs/4.x/directory-structure/app/app-config.md): Expose reactive configuration within your application with the App Config file.
- [error.vue](https://nuxt.com/raw/docs/4.x/directory-structure/app/error.md): The error.vue file is the error page in your Nuxt application.
- [spa-loading-template.html](https://nuxt.com/raw/docs/4.x/directory-structure/app/spa-loading-template.md): The spa-loading-template.html file defines the loading screen shown while a client-side rendered page initializes.
- [content](https://nuxt.com/raw/docs/4.x/directory-structure/content.md): Use the content/ directory to create a file-based CMS for your application.
- [layers](https://nuxt.com/raw/docs/4.x/directory-structure/layers.md): Use the layers/ directory to organize and auto-register local layers within your application.
- [modules](https://nuxt.com/raw/docs/4.x/directory-structure/modules.md): Use the modules/ directory to automatically register local modules within your application.
- [node_modules](https://nuxt.com/raw/docs/4.x/directory-structure/node_modules.md): The package manager stores the dependencies of your project in the node_modules/ directory.
- [public](https://nuxt.com/raw/docs/4.x/directory-structure/public.md): The public/ directory is used to serve your website's static assets.
- [server](https://nuxt.com/raw/docs/4.x/directory-structure/server.md): The server/ directory is used to register API and server handlers to your application.
- [shared](https://nuxt.com/raw/docs/4.x/directory-structure/shared.md): Use the shared/ directory to share functionality between the Vue app and the Nitro server.
- [test](https://nuxt.com/raw/docs/4.x/directory-structure/test.md): Use the test/ directory to organize unit, Nuxt, and end-to-end tests for your application.
- [.env](https://nuxt.com/raw/docs/4.x/directory-structure/env.md): A .env file specifies your build/dev-time environment variables.
- [.gitignore](https://nuxt.com/raw/docs/4.x/directory-structure/gitignore.md): A .gitignore file specifies intentionally untracked files that git should ignore.
- [.nuxtignore](https://nuxt.com/raw/docs/4.x/directory-structure/nuxtignore.md): The .nuxtignore file lets Nuxt ignore files in your project’s root directory during the build phase.
- [.nuxtrc](https://nuxt.com/raw/docs/4.x/directory-structure/nuxtrc.md): The .nuxtrc file allows you to define nuxt configurations in a flat syntax.
- [nuxt.config.ts](https://nuxt.com/raw/docs/4.x/directory-structure/nuxt-config.md): Nuxt can be easily configured with a single nuxt.config file.
- [package.json](https://nuxt.com/raw/docs/4.x/directory-structure/package.md): The package.json file contains all the dependencies and scripts for your application.
- [tsconfig.json](https://nuxt.com/raw/docs/4.x/directory-structure/tsconfig.md): Learn how Nuxt manages TypeScript configuration across different parts of your project.
- [Rendering Modes](https://nuxt.com/raw/docs/4.x/guide/concepts/rendering.md): Learn about the different rendering modes available in Nuxt.
- [Nuxt Lifecycle](https://nuxt.com/raw/docs/4.x/guide/concepts/nuxt-lifecycle.md): Understanding the lifecycle of Nuxt applications can help you gain deeper insights into how the framework operates, especially for both server-side and client-side rendering.
- [Auto-imports](https://nuxt.com/raw/docs/4.x/guide/concepts/auto-imports.md): Nuxt auto-imports components, composables, helper functions and Vue APIs.
- [Server Engine](https://nuxt.com/raw/docs/4.x/guide/concepts/server-engine.md): Nuxt is powered by a new server engine: Nitro.
- [Modules](https://nuxt.com/raw/docs/4.x/guide/concepts/modules.md): Nuxt provides a module system to extend the framework core and simplify integrations.
- [Server Components](https://nuxt.com/raw/docs/4.x/guide/concepts/server-components.md): Render individual components on the server only, keeping their JavaScript out of your client bundle.
- [TypeScript](https://nuxt.com/raw/docs/4.x/guide/concepts/typescript.md): Nuxt is fully typed and provides helpful shortcuts to ensure you have access to accurate type information when you are coding.
- [Code Style](https://nuxt.com/raw/docs/4.x/guide/concepts/code-style.md): Nuxt supports ESLint out of the box
- [Accessibility](https://nuxt.com/raw/docs/4.x/guide/best-practices/accessibility.md): Best practices for accessibility in Nuxt apps.
- [Dev Containers](https://nuxt.com/raw/docs/4.x/guide/best-practices/devcontainers.md): Set up or open a Nuxt project in a dev container for a consistent development environment.
- [Nuxt and Hydration](https://nuxt.com/raw/docs/4.x/guide/best-practices/hydration.md): Why fixing hydration issues is important
- [Nuxt Performance](https://nuxt.com/raw/docs/4.x/guide/best-practices/performance.md): Best practices for improving performance of Nuxt apps.
- [Nuxt Plugins](https://nuxt.com/raw/docs/4.x/guide/best-practices/plugins.md): Best practices when using Nuxt plugins.
- [MCP Server](https://nuxt.com/raw/docs/4.x/guide/ai/mcp.md): Use Nuxt documentation in your AI assistants with Model Context Protocol support.
- [LLMs.txt](https://nuxt.com/raw/docs/4.x/guide/ai/llms-txt.md): How to get AI tools like Cursor, Windsurf, GitHub Copilot, ChatGPT, and Claude to understand Nuxt concepts, APIs, and best practices.
- [Create Your First Module](https://nuxt.com/raw/docs/4.x/guide/modules/getting-started.md): Learn how to create your first Nuxt module using the official starter template.
- [Understand Module Structure](https://nuxt.com/raw/docs/4.x/guide/modules/module-anatomy.md): Learn how Nuxt modules are structured and how to define them.
- [Add Plugins, Components & More](https://nuxt.com/raw/docs/4.x/guide/modules/recipes-basics.md): Learn how to inject plugins, components, composables and server routes from your module.
- [Module Dependencies](https://nuxt.com/raw/docs/4.x/guide/modules/module-dependencies.md): Declare dependencies on other modules with version constraints and configuration merging.
- [Use Hooks & Extend Types](https://nuxt.com/raw/docs/4.x/guide/modules/recipes-advanced.md): Master lifecycle hooks, virtual files and TypeScript declarations in your modules.
- [Test Your Module](https://nuxt.com/raw/docs/4.x/guide/modules/testing.md): Learn how to test your Nuxt module with unit, integration and E2E tests.
- [Follow Best Practices](https://nuxt.com/raw/docs/4.x/guide/modules/best-practices.md): Build performant and maintainable Nuxt modules with these guidelines.
- [Publish & Share Your Module](https://nuxt.com/raw/docs/4.x/guide/modules/ecosystem.md): Join the Nuxt module ecosystem and publish your module to npm.
- [Server Compatibility](https://nuxt.com/raw/docs/4.x/guide/modules/server-compatibility.md): Ship one module that serves Nuxt 4 and Nuxt 5, whichever server runtime is underneath.
- [Custom Routing](https://nuxt.com/raw/docs/4.x/guide/recipes/custom-routing.md): In Nuxt, your routing is defined by the structure of your files inside the pages directory. However, since it uses vue-router under the hood, Nuxt offers you several ways to add custom routes in your project.
- [Vite Plugins](https://nuxt.com/raw/docs/4.x/guide/recipes/vite-plugin.md): Learn how to integrate Vite plugins into your Nuxt project.
- [Custom useFetch](https://nuxt.com/raw/docs/4.x/guide/recipes/custom-usefetch.md): How to create a custom fetcher for calling your external API in Nuxt.
- [Sessions and Authentication](https://nuxt.com/raw/docs/4.x/guide/recipes/sessions-and-authentication.md): Authentication is an extremely common requirement in web apps. This recipe will show you how to implement basic user registration and authentication in your Nuxt app.
- [Mostly-Static Sites](https://nuxt.com/raw/docs/4.x/guide/recipes/mostly-static-sites.md): Ship near-zero JavaScript for content and marketing sites while keeping islands of interactivity.
- [Custom Events](https://nuxt.com/raw/docs/4.x/guide/going-further/events.md): Nuxt provides a powerful event system powered by hookable.
- [Experimental Features](https://nuxt.com/raw/docs/4.x/guide/going-further/experimental-features.md): Enable Nuxt experimental features to unlock new possibilities.
- [Features](https://nuxt.com/raw/docs/4.x/guide/going-further/features.md): Enable or disable optional Nuxt features to unlock new possibilities.
- [Lifecycle Hooks](https://nuxt.com/raw/docs/4.x/guide/going-further/hooks.md): Nuxt provides a powerful hooking system to expand almost every aspect using hooks.
- [Nuxt Kit](https://nuxt.com/raw/docs/4.x/guide/going-further/kit.md): @nuxt/kit provides features for module authors.
- [Server Imports](https://nuxt.com/raw/docs/4.x/guide/going-further/server-imports.md): `nuxt/server` is the import surface for server code that isn't tied to a particular server runtime.
- [NuxtApp](https://nuxt.com/raw/docs/4.x/guide/going-further/nuxt-app.md): In Nuxt, you can access runtime app context within composables, components and plugins.
- [Authoring Nuxt Layers](https://nuxt.com/raw/docs/4.x/guide/going-further/layers.md): Nuxt provides a powerful system that allows you to extend the default files, configs, and much more.
- [Creating a Builder](https://nuxt.com/raw/docs/4.x/guide/going-further/builders.md): Learn how Nuxt builders work and how to author your own.
- [Debugging](https://nuxt.com/raw/docs/4.x/guide/going-further/debugging.md): In Nuxt, you can get started with debugging your application directly in the browser as well as in your IDE.
- [Runtime Config](https://nuxt.com/raw/docs/4.x/guide/going-further/runtime-config.md): Nuxt provides a runtime config API to expose configuration and secrets within your application.
- [Nightly Release Channel](https://nuxt.com/raw/docs/4.x/guide/going-further/nightly-release-channel.md): The nightly release channel allows using Nuxt built directly from the latest commits to the repository.
- [<ClientOnly>](https://nuxt.com/raw/docs/4.x/api/components/client-only.md): Render components only in client-side with the <ClientOnly> component.
- [<DevOnly>](https://nuxt.com/raw/docs/4.x/api/components/dev-only.md): Render components only during development with the <DevOnly> component.
- [<NuxtClientFallback>](https://nuxt.com/raw/docs/4.x/api/components/nuxt-client-fallback.md): Nuxt provides the <NuxtClientFallback> component to render its content on the client if any of its children trigger an error in SSR
- [<NuxtPage>](https://nuxt.com/raw/docs/4.x/api/components/nuxt-page.md): The <NuxtPage> component is required to display pages located in the pages/ directory.
- [<NuxtLayout>](https://nuxt.com/raw/docs/4.x/api/components/nuxt-layout.md): Nuxt provides the <NuxtLayout> component to show layouts on pages and error pages.
- [<NuxtLink>](https://nuxt.com/raw/docs/4.x/api/components/nuxt-link.md): Nuxt provides <NuxtLink> component to handle any kind of links within your application.
- [<NuxtLoadingIndicator>](https://nuxt.com/raw/docs/4.x/api/components/nuxt-loading-indicator.md): Display a progress bar between page navigations.
- [<NuxtErrorBoundary>](https://nuxt.com/raw/docs/4.x/api/components/nuxt-error-boundary.md): The <NuxtErrorBoundary> component handles client-side errors happening in its default slot.
- [<NuxtWelcome>](https://nuxt.com/raw/docs/4.x/api/components/nuxt-welcome.md): The <NuxtWelcome> component greets users in new projects made from the starter template.
- [<NuxtIsland>](https://nuxt.com/raw/docs/4.x/api/components/nuxt-island.md): Nuxt provides the