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.

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.

Available Resources

Documentation Sets

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

Nuxt v4 Documentation

• Introduction: Nuxt's goal is to make web development intuitive and performant with a great Developer Experience in mind.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/introduction.md

• Installation: Get started with Nuxt quickly with our online starters or start locally with your terminal.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/installation.md

• Configuration: Nuxt is configured with sensible defaults to make you productive.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/configuration.md

• Views: Nuxt provides several component layers to implement the user interface of your application.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/views.md

• Assets: Nuxt offers two options for your assets.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/assets.md

• Styling: Learn how to style your Nuxt application.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/styling.md

• Routing: Nuxt file-system routing creates a route for every file in the pages/ directory.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/routing.md

• SEO and Meta: Improve your Nuxt app's SEO with powerful head config, composables and components.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/seo-meta.md

• Transitions: Apply transitions between pages and layouts with Vue or native browser View Transitions.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/transitions.md

• Data Fetching: Nuxt provides composables to handle data fetching within your application.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/data-fetching.md

• State Management: Nuxt provides powerful state management libraries and the useState composable to create a reactive and SSR-friendly shared state.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/state-management.md

• Error Handling: Learn how to catch and handle errors in Nuxt.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/error-handling.md

• Server: 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.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/server.md

• Layers: Nuxt provides a powerful system that allows you to extend the default files, configs, and much more.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/layers.md

• Prerendering: Nuxt allows pages to be statically rendered at build time to improve certain performance or SEO metrics

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/prerendering.md

• Deployment: Learn how to deploy your Nuxt application to any hosting provider.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/deployment.md

• Testing: How to test your Nuxt application.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/testing.md

• Upgrade Guide: Learn how to upgrade to the latest Nuxt version.

  • URL: https://nuxt.com/raw/docs/4.x/getting-started/upgrade.md

• .nuxt: Nuxt uses the .nuxt/ directory in development to generate your Vue application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/nuxt.md

• .output: Nuxt creates the .output/ directory when building your application for production.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/output.md

• assets: The assets/ directory is used to add all the website's assets that the build tool will process.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/assets.md

• components: The components/ directory is where you put all your Vue components.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/components.md

• composables: Use the composables/ directory to auto-import your Vue composables into your application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/composables.md

• layouts: Nuxt provides a layouts framework to extract common UI patterns into reusable layouts.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/layouts.md

• middleware: Nuxt provides middleware to run code before navigating to a particular route.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/middleware.md

• pages: Nuxt provides file-based routing to create routes within your web application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/pages.md

• plugins: Nuxt has a plugins system to use Vue plugins and more at the creation of your Vue application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/plugins.md

• utils: Use the utils/ directory to auto-import your utility functions throughout your application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/utils.md

• app.vue: The app.vue file is the main component of your Nuxt application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/app.md

• app.config.ts: Expose reactive configuration within your application with the App Config file.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/app-config.md

• error.vue: The error.vue file is the error page in your Nuxt application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/app/error.md

• content: Use the content/ directory to create a file-based CMS for your application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/content.md

• layers: Use the layers/ directory to organize and auto-register local layers within your application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/layers.md

• modules: Use the modules/ directory to automatically register local modules within your application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/modules.md

• node_modules: The package manager stores the dependencies of your project in the node_modules/ directory.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/node_modules.md

• public: The public/ directory is used to serve your website's static assets.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/public.md

• server: The server/ directory is used to register API and server handlers to your application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/server.md

• shared: Use the shared/ directory to share functionality between the Vue app and the Nitro server.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/shared.md

• .env: A .env file specifies your build/dev-time environment variables.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/env.md

• .gitignore: A .gitignore file specifies intentionally untracked files that git should ignore.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/gitignore.md

• .nuxtignore: The .nuxtignore file lets Nuxt ignore files in your project’s root directory during the build phase.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/nuxtignore.md

• .nuxtrc: The .nuxtrc file allows you to define nuxt configurations in a flat syntax.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/nuxtrc.md

• nuxt.config.ts: Nuxt can be easily configured with a single nuxt.config file.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/nuxt-config.md

• package.json: The package.json file contains all the dependencies and scripts for your application.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/package.md

• tsconfig.json: Learn how Nuxt manages TypeScript configuration across different parts of your project.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure/tsconfig.md

• Nuxt Directory Structure: Learn about the directory structure of a Nuxt application and how to use it.

  • URL: https://nuxt.com/raw/docs/4.x/directory-structure.md

• Nuxt Guide: Learn how Nuxt works with in-depth guides.

  • URL: https://nuxt.com/raw/docs/4.x/guide.md

• Rendering Modes: Learn about the different rendering modes available in Nuxt.

  • URL: https://nuxt.com/raw/docs/4.x/guide/concepts/rendering.md

• Vue.js Development: Nuxt uses Vue.js and adds features such as component auto-imports, file-based routing and composables for an SSR-friendly usage.

  • URL: https://nuxt.com/raw/docs/4.x/guide/concepts/vuejs-development.md

• Nuxt Lifecycle: 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.

  • URL: https://nuxt.com/raw/docs/4.x/guide/concepts/nuxt-lifecycle.md

• Auto-imports: Nuxt auto-imports components, composables, helper functions and Vue APIs.

  • URL: https://nuxt.com/raw/docs/4.x/guide/concepts/auto-imports.md

• Server Engine: Nuxt is powered by a new server engine: Nitro.

  • URL: https://nuxt.com/raw/docs/4.x/guide/concepts/server-engine.md

• Modules: Nuxt provides a module system to extend the framework core and simplify integrations.

  • URL: https://nuxt.com/raw/docs/4.x/guide/concepts/modules.md

• ES Modules: Nuxt uses native ES modules.

  • URL: https://nuxt.com/raw/docs/4.x/guide/concepts/esm.md

• TypeScript: Nuxt is fully typed and provides helpful shortcuts to ensure you have access to accurate type information when you are coding.

  • URL: https://nuxt.com/raw/docs/4.x/guide/concepts/typescript.md

• Code Style: Nuxt supports ESLint out of the box

  • URL: https://nuxt.com/raw/docs/4.x/guide/concepts/code-style.md

• Nuxt and hydration: Why fixing hydration issues is important

  • URL: https://nuxt.com/raw/docs/4.x/guide/best-practices/hydration.md

• Nuxt performance: Best practices for improving performance of Nuxt apps.

  • URL: https://nuxt.com/raw/docs/4.x/guide/best-practices/performance.md

• Nuxt Plugins: Best practices when using Nuxt plugins.

  • URL: https://nuxt.com/raw/docs/4.x/guide/best-practices/plugins.md

• Nuxt MCP Server: Use Nuxt documentation in your AI assistants with Model Context Protocol support.

  • URL: https://nuxt.com/raw/docs/4.x/guide/ai/mcp.md

• Nuxt LLMs.txt: How to get AI tools like Cursor, Windsurf, GitHub Copilot, ChatGPT, and Claude to understand Nuxt concepts, APIs, and best practices.

  • URL: https://nuxt.com/raw/docs/4.x/guide/ai/llms-txt.md

• Create Your First Module: Learn how to create your first Nuxt module using the official starter template.

  • URL: https://nuxt.com/raw/docs/4.x/guide/modules/getting-started.md

• Understand Module Structure: Learn how Nuxt modules are structured and how to define them.

  • URL: https://nuxt.com/raw/docs/4.x/guide/modules/module-anatomy.md

• Add Plugins, Components & More: Learn how to inject plugins, components, composables and server routes from your module.

  • URL: https://nuxt.com/raw/docs/4.x/guide/modules/recipes-basics.md

• Use Hooks & Extend Types: Master lifecycle hooks, virtual files and TypeScript declarations in your modules.

  • URL: https://nuxt.com/raw/docs/4.x/guide/modules/recipes-advanced.md

• Test Your Module: Learn how to test your Nuxt module with unit, integration and E2E tests.

  • URL: https://nuxt.com/raw/docs/4.x/guide/modules/testing.md

• Follow Best Practices: Build performant and maintainable Nuxt modules with these guidelines.

  • URL: https://nuxt.com/raw/docs/4.x/guide/modules/best-practices.md

• Publish & Share Your Module: Join the Nuxt module ecosystem and publish your module to npm.

  • URL: https://nuxt.com/raw/docs/4.x/guide/modules/ecosystem.md

• Module Author Guide: Learn how to create a Nuxt module to integrate, enhance or extend any Nuxt applications.

  • URL: https://nuxt.com/raw/docs/4.x/guide/modules.md

• Custom Routing: 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.

  • URL: https://nuxt.com/raw/docs/4.x/guide/recipes/custom-routing.md

• Using Vite Plugins in Nuxt: Learn how to integrate Vite plugins into your Nuxt project.

  • URL: https://nuxt.com/raw/docs/4.x/guide/recipes/vite-plugin.md

• Custom useFetch in Nuxt: How to create a custom fetcher for calling your external API in Nuxt.

  • URL: https://nuxt.com/raw/docs/4.x/guide/recipes/custom-usefetch.md

• Sessions and Authentication: 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.

  • URL: https://nuxt.com/raw/docs/4.x/guide/recipes/sessions-and-authentication.md

• Creating Custom Events: Nuxt provides a powerful event system powered by hookable.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/events.md

• Experimental Features: Enable Nuxt experimental features to unlock new possibilities.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/experimental-features.md

• Features: Enable or disable optional Nuxt features to unlock new possibilities.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/features.md

• How Nuxt Works?: Nuxt is a minimal but highly customizable framework to build web applications.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/internals.md

• Runtime Config: Nuxt provides a runtime config API to expose configuration and secrets within your application.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/runtime-config.md

• Nightly Release Channel: The nightly release channel allows using Nuxt built directly from the latest commits to the repository.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/nightly-release-channel.md

• Lifecycle Hooks: Nuxt provides a powerful hooking system to expand almost every aspect using hooks.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/hooks.md

• Nuxt Kit: @nuxt/kit provides features for module authors.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/kit.md

• NuxtApp: In Nuxt, you can access runtime app context within composables, components and plugins.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/nuxt-app.md

• Authoring Nuxt Layers: Nuxt provides a powerful system that allows you to extend the default files, configs, and much more.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/layers.md

• Debugging: In Nuxt, you can get started with debugging your application directly in the browser as well as in your IDE.

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further/debugging.md

• Link: [](

  • URL: https://nuxt.com/raw/docs/4.x/guide/going-further.md)

• : Render components only in client-side with the component.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/client-only.md

• : Render components only during development with the component.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/dev-only.md

• : Nuxt provides the component to render its content on the client if any of its children trigger an error in SSR

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-client-fallback.md

• : Nuxt provides a component to handle automatic image optimization.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-picture.md

• : The component teleports a component to a different location in the DOM.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/teleports.md

• : The component adds a hidden element with the page title to announce route changes to assistive technologies.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-route-announcer.md

• : The component displays time in a locale-friendly format with server-client consistency.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-time.md

• : The component is required to display pages located in the pages/ directory.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-page.md

• : Nuxt provides the component to show layouts on pages and error pages.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-layout.md

• : Nuxt provides component to handle any kind of links within your application.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-link.md

• : Display a progress bar between page navigations.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-loading-indicator.md

• : The component handles client-side errors happening in its default slot.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-error-boundary.md

• : The component greets users in new projects made from the starter template.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-welcome.md

• : Nuxt provides the component to render a non-interactive component without any client JS.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-island.md

• : Nuxt provides a component to handle automatic image optimization.

  • URL: https://nuxt.com/raw/docs/4.x/api/components/nuxt-img.md

• onPrehydrate: Use onPrehydrate to run a callback on the client immediately before Nuxt hydrates the page.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/on-prehydrate.md

• useAppConfig: Access the reactive app config defined in the project.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-app-config.md

• useAsyncData: useAsyncData provides access to data that resolves asynchronously in an SSR-friendly composable.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-async-data.md

• useCookie: useCookie is an SSR-friendly composable to read and write cookies.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-cookie.md

• useError: useError composable returns the global Nuxt error that is being handled.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-error.md

• useFetch: Fetch data from an API endpoint with an SSR-friendly composable.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-fetch.md

• useHead: useHead customizes the head properties of individual pages of your Nuxt app.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-head.md

• useHeadSafe: The recommended way to provide head data with user input.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-head-safe.md

• useHydration: Allows full control of the hydration cycle to set and receive data from the server.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-hydration.md

• useLazyAsyncData: This wrapper around useAsyncData triggers navigation immediately.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-lazy-async-data.md

• useLazyFetch: This wrapper around useFetch triggers navigation immediately.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-lazy-fetch.md

• useLoadingIndicator: This composable gives you access to the loading state of the app page.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-loading-indicator.md

• useNuxtApp: Access the shared runtime context of the Nuxt Application.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-nuxt-app.md

• useNuxtData: Access the current cached value of data fetching composables.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-nuxt-data.md

• usePreviewMode: Use usePreviewMode to check and control preview mode in Nuxt

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-preview-mode.md

• useRequestEvent: Access the incoming request event with the useRequestEvent composable.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-request-event.md

• useRequestFetch: Forward the request context and headers for server-side fetch requests with the useRequestFetch composable.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-request-fetch.md

• useRequestHeader: Use useRequestHeader to access a certain incoming request header.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-request-header.md

• useRequestHeaders: Use useRequestHeaders to access the incoming request headers.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-request-headers.md

• useRequestURL: Access the incoming request URL with the useRequestURL composable.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-request-url.md

• useResponseHeader: Use useResponseHeader to set a server response header.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-response-header.md

• useRoute: The useRoute composable returns the current route.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-route.md

• useRouteAnnouncer: This composable observes the page title changes and updates the announcer message accordingly.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-route-announcer.md

• useRouter: The useRouter composable returns the router instance.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-router.md

• useRuntimeConfig: Access runtime config variables with the useRuntimeConfig composable.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-runtime-config.md

• useRuntimeHook: Registers a runtime hook in a Nuxt application and ensures it is properly disposed of when the scope is destroyed.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-runtime-hook.md

• useSeoMeta: The useSeoMeta composable lets you define your site's SEO meta tags as a flat object with full TypeScript support.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-seo-meta.md

• useServerSeoMeta: The useServerSeoMeta composable lets you define your site's SEO meta tags as a flat object with full TypeScript support.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-server-seo-meta.md

• useState: The useState composable creates a reactive and SSR-friendly shared state.

  • URL: https://nuxt.com/raw/docs/4.x/api/composables/use-state.md

• $fetch: Nuxt uses ofetch to expose globally the $fetch helper for making HTTP requests.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/dollarfetch.md

• abortNavigation: abortNavigation is a helper function that prevents navigation from taking place and throws an error if one is set as a parameter.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/abort-navigation.md

• addRouteMiddleware: addRouteMiddleware() is a helper function to dynamically add middleware in your application.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/add-route-middleware.md

• callOnce: Run a given function or block of code once during SSR or CSR.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/call-once.md

• clearError: The clearError composable clears all handled errors.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/clear-error.md

• clearNuxtData: Delete cached data, error status and pending promises of useAsyncData and useFetch.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/clear-nuxt-data.md

• clearNuxtState: Delete the cached state of useState.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/clear-nuxt-state.md

• createError: Create an error object with additional metadata.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/create-error.md

• defineLazyHydrationComponent: Define a lazy hydration component with a specific strategy.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/define-lazy-hydration-component.md

• defineNuxtComponent: defineNuxtComponent() is a helper function for defining type safe components with Options API.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/define-nuxt-component.md

• defineNuxtPlugin: defineNuxtPlugin() is a helper function for creating Nuxt plugins.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/define-nuxt-plugin.md

• defineNuxtRouteMiddleware: Create named route middleware using defineNuxtRouteMiddleware helper function.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/define-nuxt-route-middleware.md

• definePageMeta: Define metadata for your page components.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/define-page-meta.md

• defineRouteRules: Define route rules for hybrid rendering at the page level.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/define-route-rules.md

• navigateTo: navigateTo is a helper function that programmatically navigates users.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/navigate-to.md

• onBeforeRouteLeave: The onBeforeRouteLeave composable allows registering a route guard within a component.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/on-before-route-leave.md

• onBeforeRouteUpdate: The onBeforeRouteUpdate composable allows registering a route guard within a component.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/on-before-route-update.md

• onNuxtReady: The onNuxtReady composable allows running a callback after your app has finished initializing.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/on-nuxt-ready.md

• prefetchComponents: Nuxt provides utilities to give you control over prefetching components.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/prefetch-components.md

• preloadComponents: Nuxt provides utilities to give you control over preloading components.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/preload-components.md

• preloadRouteComponents: preloadRouteComponents allows you to manually preload individual pages in your Nuxt app.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/preload-route-components.md

• prerenderRoutes: prerenderRoutes hints to Nitro to prerender an additional route.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/prerender-routes.md

• refreshCookie: Refresh useCookie values manually when a cookie has changed

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/refresh-cookie.md

• refreshNuxtData: Refresh all or specific asyncData instances in Nuxt

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/refresh-nuxt-data.md

• reloadNuxtApp: reloadNuxtApp will perform a hard reload of the page.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/reload-nuxt-app.md

• setPageLayout: setPageLayout allows you to dynamically change the layout of a page.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/set-page-layout.md

• setResponseStatus: setResponseStatus sets the status (and optionally the statusText) of the response.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/set-response-status.md

• showError: Nuxt provides a quick and simple way to show a full screen error page if needed.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/show-error.md

• updateAppConfig: Update the App Config at runtime.

  • URL: https://nuxt.com/raw/docs/4.x/api/utils/update-app-config.md

• nuxt add: Scaffold an entity into your Nuxt application.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/add.md

• nuxt analyze: Analyze the production bundle or your Nuxt application.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/analyze.md

• nuxt build: Build your Nuxt application.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/build.md

• nuxt build-module: Nuxt command to build your Nuxt module before publishing.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/build-module.md

• nuxt cleanup: Remove common generated Nuxt files and caches.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/cleanup.md

• nuxt dev: The dev command starts a development server with hot module replacement at http://localhost:3000

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/dev.md

• nuxt devtools: The devtools command allows you to enable or disable Nuxt DevTools on a per-project basis.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/devtools.md

• nuxt generate: Pre-renders every route of the application and stores the result in plain HTML files.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/generate.md

• nuxt info: The info command logs information about the current or specified Nuxt project.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/info.md

• create nuxt: The init command initializes a fresh Nuxt project.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/init.md

• nuxt module: Search and add modules to your Nuxt application with the command line.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/module.md

• nuxt prepare: The prepare command creates a .nuxt directory in your application and generates types.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/prepare.md

• nuxt preview: The preview command starts a server to preview your application after the build command.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/preview.md

• nuxt test: The test command runs tests using @nuxt/test-utils.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/test.md

• nuxt typecheck: The typecheck command runs vue-tsc to check types throughout your app.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/typecheck.md

• nuxt upgrade: The upgrade command upgrades Nuxt to the latest version.

  • URL: https://nuxt.com/raw/docs/4.x/api/commands/upgrade.md

• Modules: Nuxt Kit provides a set of utilities to help you create and use modules. You can use these utilities to create your own modules or to reuse existing modules.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/modules.md

• Runtime Config: Nuxt Kit provides a set of utilities to help you access and modify Nuxt runtime configuration.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/runtime-config.md

• Templates: Nuxt Kit provides a set of utilities to help you work with templates. These functions allow you to generate extra files during development and build time.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/templates.md

• Nitro: Nuxt Kit provides a set of utilities to help you work with Nitro. These functions allow you to add server handlers, plugins, and prerender routes.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/nitro.md

• Resolving: Nuxt Kit provides a set of utilities to help you resolve paths. These functions allow you to resolve paths relative to the current module, with unknown name or extension.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/resolving.md

• Logging: Nuxt Kit provides a set of utilities to help you work with logging. These functions allow you to log messages with extra features.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/logging.md

• Builder: Nuxt Kit provides a set of utilities to help you work with the builder. These functions allow you to extend the Vite and webpack configurations.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/builder.md

• Examples: Examples of Nuxt Kit utilities in use.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/examples.md

• Layers: Nuxt Kit provides utilities to help you work with layers and their directory structures.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/layers.md

• Programmatic Usage: Nuxt Kit provides a set of utilities to help you work with Nuxt programmatically. These functions allow you to load Nuxt, build Nuxt, and load Nuxt configuration.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/programmatic.md

• Compatibility: Nuxt Kit provides a set of utilities to help you check the compatibility of your modules with different Nuxt versions.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/compatibility.md

• Auto-imports: Nuxt Kit provides a set of utilities to help you work with auto-imports. These functions allow you to register your own utils, composables and Vue APIs.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/autoimports.md

• Components: Nuxt Kit provides a set of utilities to help you work with components. You can register components globally or locally, and also add directories to be scanned for components.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/components.md

• Context: Nuxt Kit provides a set of utilities to help you work with context.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/context.md

• Pages: Nuxt Kit provides a set of utilities to help you create and use pages. You can use these utilities to manipulate the pages configuration or to define route rules.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/pages.md

• Layout: Nuxt Kit provides a set of utilities to help you work with layouts.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/layout.md

• Head: Nuxt Kit provides utilities to help you manage head configuration in modules.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/head.md

• Plugins: Nuxt Kit provides a set of utilities to help you create and use plugins. You can add plugins or plugin templates to your module using these functions.

  • URL: https://nuxt.com/raw/docs/4.x/api/kit/plugins.md

• Lifecycle Hooks: Nuxt provides a powerful hooking system to expand almost every aspect using hooks.

  • URL: https://nuxt.com/raw/docs/4.x/api/advanced/hooks.md

• Import meta: Understand where your code is running using import.meta.

  • URL: https://nuxt.com/raw/docs/4.x/api/advanced/import-meta.md

• Nuxt Configuration: Discover all the options you can use in your nuxt.config.ts file.

  • URL: https://nuxt.com/raw/docs/4.x/api/nuxt-config.md

• Nuxt API Reference: Explore all Nuxt Internals: Components, Composables, Utils, Commands and more.

  • URL: https://nuxt.com/raw/docs/4.x/api.md

• Hello World: A minimal Nuxt application only requires the app.vue and nuxt.config.js files.

  • URL: https://nuxt.com/raw/docs/4.x/examples/hello-world.md

• Auto Imports: This example demonstrates the auto-imports feature in Nuxt.

  • URL: https://nuxt.com/raw/docs/4.x/examples/features/auto-imports.md

• Data Fetching: This example demonstrates data fetching with Nuxt using built-in composables and API routes.

  • URL: https://nuxt.com/raw/docs/4.x/examples/features/data-fetching.md

• State Management: This example shows how to use the useState composable to create a reactive and SSR-friendly shared state across components.

  • URL: https://nuxt.com/raw/docs/4.x/examples/features/state-management.md

• Meta Tags: This example shows how to use the Nuxt helpers and composables for SEO and meta management.

  • URL: https://nuxt.com/raw/docs/4.x/examples/features/meta-tags.md

• Layouts: This example shows how to define default and custom layouts.

  • URL: https://nuxt.com/raw/docs/4.x/examples/features/layouts.md

• Middleware: This example shows how to add route middleware with the middleware/ directory or with a plugin, and how to use them globally or per page.

  • URL: https://nuxt.com/raw/docs/4.x/examples/routing/middleware.md

• Pages: This example shows how to use the pages/ directory to create application routes.

  • URL: https://nuxt.com/raw/docs/4.x/examples/routing/pages.md

• Universal Router: This example demonstrates Nuxt universal routing utilities without depending on pages/ and vue-router.

  • URL: https://nuxt.com/raw/docs/4.x/examples/routing/universal-router.md

• Layers: This example shows how to use the extends key in nuxt.config.ts.

  • URL: https://nuxt.com/raw/docs/4.x/examples/advanced/config-extends.md

• Error Handling: This example shows how to handle errors in different contexts: pages, plugins, components and middleware.

  • URL: https://nuxt.com/raw/docs/4.x/examples/advanced/error-handling.md

• JSX / TSX: This example shows how to use JSX syntax with typescript in Nuxt pages and components.

  • URL: https://nuxt.com/raw/docs/4.x/examples/advanced/jsx.md

• Locale: This example shows how to define a locale composable to handle the application's locale, both server and client side.

  • URL: https://nuxt.com/raw/docs/4.x/examples/advanced/locale.md

• Module Extend Pages: This example defines a new test page using extendPages within a module.

  • URL: https://nuxt.com/raw/docs/4.x/examples/advanced/module-extend-pages.md

• Teleport: This example shows how to use the with client-side and server-side rendering.

  • URL: https://nuxt.com/raw/docs/4.x/examples/advanced/teleport.md

• Testing: This example shows how to test your Nuxt application.

  • URL: https://nuxt.com/raw/docs/4.x/examples/advanced/testing.md

• useCookie: This example shows how to use the useCookie API to persist small amounts of data that both client and server can use.

  • URL: https://nuxt.com/raw/docs/4.x/examples/advanced/use-cookie.md

• Use Custom Fetch Composable: This example shows a convenient wrapper for the useFetch composable from nuxt. It allows you to customize the fetch request with default values and user authentication token.

  • URL: https://nuxt.com/raw/docs/4.x/examples/advanced/use-custom-fetch-composable.md

• WASM: This example demonstrates the server-side support of WebAssembly in Nuxt.

  • URL: https://nuxt.com/raw/docs/4.x/examples/experimental/wasm.md

• Getting Help: We're a friendly community of developers and we'd love to help.

  • URL: https://nuxt.com/raw/docs/4.x/community/getting-help.md

• Reporting Bugs: One of the most valuable roles in open source is taking the time to report bugs helpfully.

  • URL: https://nuxt.com/raw/docs/4.x/community/reporting-bugs.md

• Contribution: Nuxt is a community project - and so we love contributions of all kinds! ❤️

  • URL: https://nuxt.com/raw/docs/4.x/community/contribution.md

• Framework: Some specific points about contributions to the framework repository.

  • URL: https://nuxt.com/raw/docs/4.x/community/framework-contribution.md

• Roadmap: Nuxt is constantly evolving, with new features and modules being added all the time.

  • URL: https://nuxt.com/raw/docs/4.x/community/roadmap.md

• Releases: Discover the latest releases of Nuxt & Nuxt official modules.

  • URL: https://nuxt.com/raw/docs/4.x/community/changelog.md

• Overview: Reduce the differences with Nuxt 3 and reduce the burden of migration to Nuxt 3.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/overview.md

• Configuration: Learn how to configure Nuxt Bridge to your own needs.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/configuration.md

• TypeScript: Learn how to use TypeScript with Nuxt Bridge.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/typescript.md

• Legacy Composition API: Learn how to migrate to Composition API with Nuxt Bridge.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/bridge-composition-api.md

• Plugins and Middleware: Learn how to migrate from Nuxt 2 to Nuxt Bridge new plugins and middleware.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/plugins-and-middleware.md

• New Composition API: Nuxt Bridge implements composables compatible with Nuxt 3.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/nuxt3-compatible-api.md

• Meta Tags: Learn how to migrate from Nuxt 2 to Nuxt Bridge new meta tags.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/meta.md

• Runtime Config: Nuxt provides a runtime config API to expose configuration and secrets within your application.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/runtime-config.md

• Nitro: Activate Nitro to your Nuxt 2 application with Nuxt Bridge.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/nitro.md

• Vite: Activate Vite to your Nuxt 2 application with Nuxt Bridge.

  • URL: https://nuxt.com/raw/docs/4.x/bridge/vite.md

• Overview: Nuxt 3 is a complete rewrite of Nuxt 2, and also based on a new set of underlying technologies.

  • URL: https://nuxt.com/raw/docs/4.x/migration/overview.md

• Build Tooling: Learn how to migrate from Nuxt 2 to Nuxt 3 build tooling.

  • URL: https://nuxt.com/raw/docs/4.x/migration/bundling.md

• Server: Learn how to migrate from Nuxt 2 to Nuxt 3 server.

  • URL: https://nuxt.com/raw/docs/4.x/migration/server.md

• Configuration: Learn how to migrate from Nuxt 2 to Nuxt 3 new configuration.

  • URL: https://nuxt.com/raw/docs/4.x/migration/configuration.md

• Modules: Learn how to migrate from Nuxt 2 to Nuxt 3 modules.

  • URL: https://nuxt.com/raw/docs/4.x/migration/module-authors.md

• Auto Imports: Nuxt 3 adopts a minimal friction approach, meaning wherever possible components and composables are auto-imported.

  • URL: https://nuxt.com/raw/docs/4.x/migration/auto-imports.md

• Meta Tags: Manage your meta tags, from Nuxt 2 to Nuxt 3.

  • URL: https://nuxt.com/raw/docs/4.x/migration/meta.md

• Plugins and Middleware: Learn how to migrate from Nuxt 2 to Nuxt 3 plugins and middleware.

  • URL: https://nuxt.com/raw/docs/4.x/migration/plugins-and-middleware.md

• Pages and Layouts: Learn how to migrate from Nuxt 2 to Nuxt 3 pages and layouts.

  • URL: https://nuxt.com/raw/docs/4.x/migration/pages-and-layouts.md

• Component Options: Learn how to migrate from Nuxt 2 components options to Nuxt 3 composables.

  • URL: https://nuxt.com/raw/docs/4.x/migration/component-options.md

• Runtime Config: Learn how to migrate from Nuxt 2 to Nuxt 3 runtime config.

  • URL: https://nuxt.com/raw/docs/4.x/migration/runtime-config.md

• Nuxt Docs: This repository contains the documentation of Nuxt, hosted on https://nuxt.com/docs/4.x/getting-started/introduction

  • URL: https://nuxt.com/raw/docs/4.x/readme.md

Deployment Guides

• AWS Amplify: Deploy your Nuxt Application to AWS Amplify infrastructure.

  • URL: https://nuxt.com/raw/deploy/aws-amplify.md

• Azure: Deploy your Nuxt Application to Azure infrastructure.

  • URL: https://nuxt.com/raw/deploy/azure.md

• Cleavr: Deploy your Nuxt Application to Cleavr infrastructure.

  • URL: https://nuxt.com/raw/deploy/cleavr.md

• Clever Cloud: Deploy your Nuxt Application to Clever Cloud infrastructure.

  • URL: https://nuxt.com/raw/deploy/clever-cloud.md

• Cloudflare: Deploy your Nuxt Application to Cloudflare infrastructure.

  • URL: https://nuxt.com/raw/deploy/cloudflare.md

• Deno Deploy: Deploy your Nuxt Application to Deno Deploy infrastructure.

  • URL: https://nuxt.com/raw/deploy/deno-deploy.md

• DigitalOcean: Deploy your Nuxt Application to DigitalOcean infrastructure.

  • URL: https://nuxt.com/raw/deploy/digitalocean.md

• Firebase: Deploy your Nuxt Application to Firebase infrastructure.

  • URL: https://nuxt.com/raw/deploy/firebase.md

• Flightcontrol: Deploy your Nuxt Application to Flightcontrol infrastructure.

  • URL: https://nuxt.com/raw/deploy/flightcontrol.md

• GitHub Pages: Deploy your Nuxt Application to GitHub Pages infrastructure.

  • URL: https://nuxt.com/raw/deploy/github-pages.md

• GitLab Pages: Deploy your Nuxt Application to GitLab Pages.

  • URL: https://nuxt.com/raw/deploy/gitlab.md

• Heroku: Deploy your Nuxt Application to Heroku infrastructure.

  • URL: https://nuxt.com/raw/deploy/heroku.md

• IIS: Deploy your Nuxt Application to IIS infrastructure.

  • URL: https://nuxt.com/raw/deploy/iis.md

• Koyeb: Deploy your Nuxt Application to Koyeb infrastructure.

  • URL: https://nuxt.com/raw/deploy/koyeb.md

• Netlify: Deploy your Nuxt Application to Netlify infrastructure.

  • URL: https://nuxt.com/raw/deploy/netlify.md

• Northflank: Deploy your Nuxt Application to Northflank infrastructure.

  • URL: https://nuxt.com/raw/deploy/northflank.md

• Render: Deploy your Nuxt Application to Render infrastructure.

  • URL: https://nuxt.com/raw/deploy/render.md

• SST: Deploy your Nuxt Application to AWS with SST.

  • URL: https://nuxt.com/raw/deploy/sst.md

• Stormkit: Deploy your Nuxt Application to Stormkit infrastructure.

  • URL: https://nuxt.com/raw/deploy/stormkit.md

• Vercel: Deploy your Nuxt Application to Vercel infrastructure.

  • URL: https://nuxt.com/raw/deploy/vercel.md

• Zeabur: Deploy your Nuxt Application to Zeabur.

  • URL: https://nuxt.com/raw/deploy/zeabur.md

• Zerops: Deploy your Nuxt Application to Zerops infrastructure.

  • URL: https://nuxt.com/raw/deploy/zerops.md

Nuxt v3 Documentation

• Introduction: Nuxt's goal is to make web development intuitive and performant with a great Developer Experience in mind.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/introduction.md

• Installation: Get started with Nuxt quickly with our online starters or start locally with your terminal.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/installation.md

• Configuration: Nuxt is configured with sensible defaults to make you productive.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/configuration.md

• Views: Nuxt provides several component layers to implement the user interface of your application.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/views.md

• Assets: Nuxt offers two options for your assets.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/assets.md

• Styling: Learn how to style your Nuxt application.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/styling.md

• Routing: Nuxt file-system routing creates a route for every file in the pages/ directory.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/routing.md

• SEO and Meta: Improve your Nuxt app's SEO with powerful head config, composables and components.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/seo-meta.md

• Transitions: Apply transitions between pages and layouts with Vue or native browser View Transitions.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/transitions.md

• Data Fetching: Nuxt provides composables to handle data fetching within your application.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/data-fetching.md

• State Management: Nuxt provides powerful state management libraries and the useState composable to create a reactive and SSR-friendly shared state.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/state-management.md

• Error Handling: Learn how to catch and handle errors in Nuxt.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/error-handling.md

• Server: 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.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/server.md

• Layers: Nuxt provides a powerful system that allows you to extend the default files, configs, and much more.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/layers.md

• Prerendering: Nuxt allows pages to be statically rendered at build time to improve certain performance or SEO metrics

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/prerendering.md

• Deployment: Learn how to deploy your Nuxt application to any hosting provider.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/deployment.md

• Testing: How to test your Nuxt application.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/testing.md

• Upgrade Guide: Learn how to upgrade to the latest Nuxt version.

  • URL: https://nuxt.com/raw/docs/3.x/getting-started/upgrade.md

• .nuxt: Nuxt uses the .nuxt/ directory in development to generate your Vue application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/nuxt.md

• .output: Nuxt creates the .output/ directory when building your application for production.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/output.md

• assets: The assets/ directory is used to add all the website's assets that the build tool will process.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/assets.md

• components: The components/ directory is where you put all your Vue components.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/components.md

• composables: Use the composables/ directory to auto-import your Vue composables into your application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/composables.md

• content: Use the content/ directory to create a file-based CMS for your application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/content.md

• layers: Use the layers/ directory to organize and auto-register local layers within your application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/layers.md

• layouts: Nuxt provides a layouts framework to extract common UI patterns into reusable layouts.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/layouts.md

• middleware: Nuxt provides middleware to run code before navigating to a particular route.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/middleware.md

• modules: Use the modules/ directory to automatically register local modules within your application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/modules.md

• node_modules: The package manager stores the dependencies of your project in the node_modules/ directory.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/node_modules.md

• pages: Nuxt provides file-based routing to create routes within your web application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/pages.md

• plugins: Nuxt has a plugins system to use Vue plugins and more at the creation of your Vue application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/plugins.md

• public: The public/ directory is used to serve your website's static assets.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/public.md

• server: The server/ directory is used to register API and server handlers to your application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/server.md

• shared: Use the shared/ directory to share functionality between the Vue app and the Nitro server.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/shared.md

• utils: Use the utils/ directory to auto-import your utility functions throughout your application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/utils.md

• .env: A .env file specifies your build/dev-time environment variables.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/env.md

• .gitignore: A .gitignore file specifies intentionally untracked files that git should ignore.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/gitignore.md

• .nuxtignore: The .nuxtignore file lets Nuxt ignore files in your project’s root directory during the build phase.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/nuxtignore.md

• .nuxtrc: The .nuxtrc file allows you to define nuxt configurations in a flat syntax.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/nuxtrc.md

• app.vue: The app.vue file is the main component of your Nuxt application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/app.md

• app.config.ts: Expose reactive configuration within your application with the App Config file.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/app-config.md

• error.vue: The error.vue file is the error page in your Nuxt application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/error.md

• nuxt.config.ts: Nuxt can be easily configured with a single nuxt.config file.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/nuxt-config.md

• package.json: The package.json file contains all the dependencies and scripts for your application.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/package.md

• tsconfig.json: Learn how Nuxt manages TypeScript configuration across different parts of your project.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure/tsconfig.md

• Nuxt Directory Structure: Learn about the directory structure of a Nuxt application and how to use it.

  • URL: https://nuxt.com/raw/docs/3.x/directory-structure.md

• Nuxt Guide: Learn how Nuxt works with in-depth guides.

  • URL: https://nuxt.com/raw/docs/3.x/guide.md

• Rendering Modes: Learn about the different rendering modes available in Nuxt.

  • URL: https://nuxt.com/raw/docs/3.x/guide/concepts/rendering.md

• Vue.js Development: Nuxt uses Vue.js and adds features such as component auto-imports, file-based routing and composables for an SSR-friendly usage.

  • URL: https://nuxt.com/raw/docs/3.x/guide/concepts/vuejs-development.md

• Nuxt Lifecycle: 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.

  • URL: https://nuxt.com/raw/docs/3.x/guide/concepts/nuxt-lifecycle.md

• Auto-imports: Nuxt auto-imports components, composables, helper functions and Vue APIs.

  • URL: https://nuxt.com/raw/docs/3.x/guide/concepts/auto-imports.md

• Server Engine: Nuxt is powered by a new server engine: Nitro.

  • URL: https://nuxt.com/raw/docs/3.x/guide/concepts/server-engine.md

• Modules: Nuxt provides a module system to extend the framework core and simplify integrations.

  • URL: https://nuxt.com/raw/docs/3.x/guide/concepts/modules.md

• ES Modules: Nuxt uses native ES modules.

  • URL: https://nuxt.com/raw/docs/3.x/guide/concepts/esm.md

• TypeScript: Nuxt is fully typed and provides helpful shortcuts to ensure you have access to accurate type information when you are coding.

  • URL: https://nuxt.com/raw/docs/3.x/guide/concepts/typescript.md

• Code Style: Nuxt supports ESLint out of the box

  • URL: https://nuxt.com/raw/docs/3.x/guide/concepts/code-style.md

• Nuxt and hydration: Why fixing hydration issues is important

  • URL: https://nuxt.com/raw/docs/3.x/guide/best-practices/hydration.md

• Nuxt performance: Best practices for improving performance of Nuxt apps.

  • URL: https://nuxt.com/raw/docs/3.x/guide/best-practices/performance.md

• Nuxt Plugins: Best practices when using Nuxt plugins.

  • URL: https://nuxt.com/raw/docs/3.x/guide/best-practices/plugins.md

• Nuxt MCP Server: Use Nuxt documentation in your AI assistants with Model Context Protocol support.

  • URL: https://nuxt.com/raw/docs/3.x/guide/ai/mcp.md

• Nuxt LLMs.txt: How to get AI tools like Cursor, Windsurf, GitHub Copilot, ChatGPT, and Claude to understand Nuxt concepts, APIs, and best practices.

  • URL: https://nuxt.com/raw/docs/3.x/guide/ai/llms-txt.md

• Create Your First Module: Learn how to create your first Nuxt module using the official starter template.

  • URL: https://nuxt.com/raw/docs/3.x/guide/modules/getting-started.md

• Understand Module Structure: Learn how Nuxt modules are structured and how to define them.

  • URL: https://nuxt.com/raw/docs/3.x/guide/modules/module-anatomy.md

• Add Plugins, Components & More: Learn how to inject plugins, components, composables and server routes from your module.

  • URL: https://nuxt.com/raw/docs/3.x/guide/modules/recipes-basics.md

• Use Hooks & Extend Types: Master lifecycle hooks, virtual files and TypeScript declarations in your modules.

  • URL: https://nuxt.com/raw/docs/3.x/guide/modules/recipes-advanced.md

• Test Your Module: Learn how to test your Nuxt module with unit, integration and E2E tests.

  • URL: https://nuxt.com/raw/docs/3.x/guide/modules/testing.md

• Follow Best Practices: Build performant and maintainable Nuxt modules with these guidelines.

  • URL: https://nuxt.com/raw/docs/3.x/guide/modules/best-practices.md

• Publish & Share Your Module: Join the Nuxt module ecosystem and publish your module to npm.

  • URL: https://nuxt.com/raw/docs/3.x/guide/modules/ecosystem.md

• Module Author Guide: Learn how to create a Nuxt module to integrate, enhance or extend any Nuxt applications.

  • URL: https://nuxt.com/raw/docs/3.x/guide/modules.md

• Custom Routing: 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.

  • URL: https://nuxt.com/raw/docs/3.x/guide/recipes/custom-routing.md

• Using Vite Plugins in Nuxt: Learn how to integrate Vite plugins into your Nuxt project.

  • URL: https://nuxt.com/raw/docs/3.x/guide/recipes/vite-plugin.md

• Custom useFetch in Nuxt: How to create a custom fetcher for calling your external API in Nuxt.

  • URL: https://nuxt.com/raw/docs/3.x/guide/recipes/custom-usefetch.md

• Sessions and Authentication: 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.

  • URL: https://nuxt.com/raw/docs/3.x/guide/recipes/sessions-and-authentication.md

• Creating Custom Events: Nuxt provides a powerful event system powered by hookable.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/events.md

• Experimental Features: Enable Nuxt experimental features to unlock new possibilities.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/experimental-features.md

• Features: Enable or disable optional Nuxt features to unlock new possibilities.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/features.md

• How Nuxt Works?: Nuxt is a minimal but highly customizable framework to build web applications.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/internals.md

• Runtime Config: Nuxt provides a runtime config API to expose configuration and secrets within your application.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/runtime-config.md

• Nightly Release Channel: The nightly release channel allows using Nuxt built directly from the latest commits to the repository.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/nightly-release-channel.md

• Lifecycle Hooks: Nuxt provides a powerful hooking system to expand almost every aspect using hooks.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/hooks.md

• Nuxt Kit: @nuxt/kit provides features for module authors.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/kit.md

• NuxtApp: In Nuxt, you can access runtime app context within composables, components and plugins.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/nuxt-app.md

• Authoring Nuxt Layers: Nuxt provides a powerful system that allows you to extend the default files, configs, and much more.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/layers.md

• Debugging: In Nuxt, you can get started with debugging your application directly in the browser as well as in your IDE.

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further/debugging.md

• Link: [](

  • URL: https://nuxt.com/raw/docs/3.x/guide/going-further.md)

• : Render components only in client-side with the component.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/client-only.md

• : Render components only during development with the component.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/dev-only.md

• : Nuxt provides the component to render its content on the client if any of its children trigger an error in SSR

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-client-fallback.md

• : Nuxt provides a component to handle automatic image optimization.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-picture.md

• : The component teleports a component to a different location in the DOM.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/teleports.md

• : The component adds a hidden element with the page title to announce route changes to assistive technologies.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-route-announcer.md

• : The component displays time in a locale-friendly format with server-client consistency.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-time.md

• : The component is required to display pages located in the pages/ directory.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-page.md

• : Nuxt provides the component to show layouts on pages and error pages.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-layout.md

• : Nuxt provides component to handle any kind of links within your application.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-link.md

• : Display a progress bar between page navigations.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-loading-indicator.md

• : The component handles client-side errors happening in its default slot.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-error-boundary.md

• : The component greets users in new projects made from the starter template.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-welcome.md

• : Nuxt provides the component to render a non-interactive component without any client JS.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-island.md

• : Nuxt provides a component to handle automatic image optimization.

  • URL: https://nuxt.com/raw/docs/3.x/api/components/nuxt-img.md

• onPrehydrate: Use onPrehydrate to run a callback on the client immediately before Nuxt hydrates the page.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/on-prehydrate.md

• useAppConfig: Access the reactive app config defined in the project.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-app-config.md

• useAsyncData: useAsyncData provides access to data that resolves asynchronously in an SSR-friendly composable.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-async-data.md

• useCookie: useCookie is an SSR-friendly composable to read and write cookies.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-cookie.md

• useError: useError composable returns the global Nuxt error that is being handled.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-error.md

• useFetch: Fetch data from an API endpoint with an SSR-friendly composable.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-fetch.md

• useHead: useHead customizes the head properties of individual pages of your Nuxt app.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-head.md

• useHeadSafe: The recommended way to provide head data with user input.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-head-safe.md

• useHydration: Allows full control of the hydration cycle to set and receive data from the server.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-hydration.md

• useLazyAsyncData: This wrapper around useAsyncData triggers navigation immediately.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-lazy-async-data.md

• useLazyFetch: This wrapper around useFetch triggers navigation immediately.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-lazy-fetch.md

• useLoadingIndicator: This composable gives you access to the loading state of the app page.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-loading-indicator.md

• useNuxtApp: Access the shared runtime context of the Nuxt Application.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-nuxt-app.md

• useNuxtData: Access the current cached value of data fetching composables.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-nuxt-data.md

• usePreviewMode: Use usePreviewMode to check and control preview mode in Nuxt

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-preview-mode.md

• useRequestEvent: Access the incoming request event with the useRequestEvent composable.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-request-event.md

• useRequestFetch: Forward the request context and headers for server-side fetch requests with the useRequestFetch composable.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-request-fetch.md

• useRequestHeader: Use useRequestHeader to access a certain incoming request header.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-request-header.md

• useRequestHeaders: Use useRequestHeaders to access the incoming request headers.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-request-headers.md

• useRequestURL: Access the incoming request URL with the useRequestURL composable.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-request-url.md

• useResponseHeader: Use useResponseHeader to set a server response header.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-response-header.md

• useRoute: The useRoute composable returns the current route.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-route.md

• useRouteAnnouncer: This composable observes the page title changes and updates the announcer message accordingly.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-route-announcer.md

• useRouter: The useRouter composable returns the router instance.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-router.md

• useRuntimeConfig: Access runtime config variables with the useRuntimeConfig composable.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-runtime-config.md

• useRuntimeHook: Registers a runtime hook in a Nuxt application and ensures it is properly disposed of when the scope is destroyed.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-runtime-hook.md

• useSeoMeta: The useSeoMeta composable lets you define your site's SEO meta tags as a flat object with full TypeScript support.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-seo-meta.md

• useServerSeoMeta: The useServerSeoMeta composable lets you define your site's SEO meta tags as a flat object with full TypeScript support.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-server-seo-meta.md

• useState: The useState composable creates a reactive and SSR-friendly shared state.

  • URL: https://nuxt.com/raw/docs/3.x/api/composables/use-state.md

• $fetch: Nuxt uses ofetch to expose globally the $fetch helper for making HTTP requests.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/dollarfetch.md

• abortNavigation: abortNavigation is a helper function that prevents navigation from taking place and throws an error if one is set as a parameter.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/abort-navigation.md

• addRouteMiddleware: addRouteMiddleware() is a helper function to dynamically add middleware in your application.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/add-route-middleware.md

• callOnce: Run a given function or block of code once during SSR or CSR.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/call-once.md

• clearError: The clearError composable clears all handled errors.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/clear-error.md

• clearNuxtData: Delete cached data, error status and pending promises of useAsyncData and useFetch.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/clear-nuxt-data.md

• clearNuxtState: Delete the cached state of useState.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/clear-nuxt-state.md

• createError: Create an error object with additional metadata.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/create-error.md

• defineLazyHydrationComponent: Define a lazy hydration component with a specific strategy.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/define-lazy-hydration-component.md

• defineNuxtComponent: defineNuxtComponent() is a helper function for defining type safe components with Options API.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/define-nuxt-component.md

• defineNuxtPlugin: defineNuxtPlugin() is a helper function for creating Nuxt plugins.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/define-nuxt-plugin.md

• defineNuxtRouteMiddleware: Create named route middleware using defineNuxtRouteMiddleware helper function.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/define-nuxt-route-middleware.md

• definePageMeta: Define metadata for your page components.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/define-page-meta.md

• defineRouteRules: Define route rules for hybrid rendering at the page level.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/define-route-rules.md

• navigateTo: navigateTo is a helper function that programmatically navigates users.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/navigate-to.md

• onBeforeRouteLeave: The onBeforeRouteLeave composable allows registering a route guard within a component.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/on-before-route-leave.md

• onBeforeRouteUpdate: The onBeforeRouteUpdate composable allows registering a route guard within a component.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/on-before-route-update.md

• onNuxtReady: The onNuxtReady composable allows running a callback after your app has finished initializing.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/on-nuxt-ready.md

• prefetchComponents: Nuxt provides utilities to give you control over prefetching components.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/prefetch-components.md

• preloadComponents: Nuxt provides utilities to give you control over preloading components.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/preload-components.md

• preloadRouteComponents: preloadRouteComponents allows you to manually preload individual pages in your Nuxt app.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/preload-route-components.md

• prerenderRoutes: prerenderRoutes hints to Nitro to prerender an additional route.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/prerender-routes.md

• refreshCookie: Refresh useCookie values manually when a cookie has changed

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/refresh-cookie.md

• refreshNuxtData: Refresh all or specific asyncData instances in Nuxt

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/refresh-nuxt-data.md

• reloadNuxtApp: reloadNuxtApp will perform a hard reload of the page.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/reload-nuxt-app.md

• setPageLayout: setPageLayout allows you to dynamically change the layout of a page.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/set-page-layout.md

• setResponseStatus: setResponseStatus sets the status (and optionally the statusText) of the response.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/set-response-status.md

• showError: Nuxt provides a quick and simple way to show a full screen error page if needed.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/show-error.md

• updateAppConfig: Update the App Config at runtime.

  • URL: https://nuxt.com/raw/docs/3.x/api/utils/update-app-config.md

• nuxt add: Scaffold an entity into your Nuxt application.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/add.md

• nuxt analyze: Analyze the production bundle or your Nuxt application.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/analyze.md

• nuxt build: Build your Nuxt application.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/build.md

• nuxt build-module: Nuxt command to build your Nuxt module before publishing.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/build-module.md

• nuxt cleanup: Remove common generated Nuxt files and caches.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/cleanup.md

• nuxt dev: The dev command starts a development server with hot module replacement at http://localhost:3000

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/dev.md

• nuxt devtools: The devtools command allows you to enable or disable Nuxt DevTools on a per-project basis.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/devtools.md

• nuxt generate: Pre-renders every route of the application and stores the result in plain HTML files.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/generate.md

• nuxt info: The info command logs information about the current or specified Nuxt project.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/info.md

• create nuxt: The init command initializes a fresh Nuxt project.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/init.md

• nuxt module: Search and add modules to your Nuxt application with the command line.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/module.md

• nuxt prepare: The prepare command creates a .nuxt directory in your application and generates types.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/prepare.md

• nuxt preview: The preview command starts a server to preview your application after the build command.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/preview.md

• nuxt test: The test command runs tests using @nuxt/test-utils.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/test.md

• nuxt typecheck: The typecheck command runs vue-tsc to check types throughout your app.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/typecheck.md

• nuxt upgrade: The upgrade command upgrades Nuxt to the latest version.

  • URL: https://nuxt.com/raw/docs/3.x/api/commands/upgrade.md

• Modules: Nuxt Kit provides a set of utilities to help you create and use modules. You can use these utilities to create your own modules or to reuse existing modules.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/modules.md

• Runtime Config: Nuxt Kit provides a set of utilities to help you access and modify Nuxt runtime configuration.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/runtime-config.md

• Templates: Nuxt Kit provides a set of utilities to help you work with templates. These functions allow you to generate extra files during development and build time.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/templates.md

• Nitro: Nuxt Kit provides a set of utilities to help you work with Nitro. These functions allow you to add server handlers, plugins, and prerender routes.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/nitro.md

• Resolving: Nuxt Kit provides a set of utilities to help you resolve paths. These functions allow you to resolve paths relative to the current module, with unknown name or extension.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/resolving.md

• Logging: Nuxt Kit provides a set of utilities to help you work with logging. These functions allow you to log messages with extra features.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/logging.md

• Builder: Nuxt Kit provides a set of utilities to help you work with the builder. These functions allow you to extend the Vite and webpack configurations.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/builder.md

• Examples: Examples of Nuxt Kit utilities in use.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/examples.md

• Layers: Nuxt Kit provides utilities to help you work with layers and their directory structures.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/layers.md

• Programmatic Usage: Nuxt Kit provides a set of utilities to help you work with Nuxt programmatically. These functions allow you to load Nuxt, build Nuxt, and load Nuxt configuration.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/programmatic.md

• Compatibility: Nuxt Kit provides a set of utilities to help you check the compatibility of your modules with different Nuxt versions.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/compatibility.md

• Auto-imports: Nuxt Kit provides a set of utilities to help you work with auto-imports. These functions allow you to register your own utils, composables and Vue APIs.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/autoimports.md

• Components: Nuxt Kit provides a set of utilities to help you work with components. You can register components globally or locally, and also add directories to be scanned for components.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/components.md

• Context: Nuxt Kit provides a set of utilities to help you work with context.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/context.md

• Pages: Nuxt Kit provides a set of utilities to help you create and use pages. You can use these utilities to manipulate the pages configuration or to define route rules.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/pages.md

• Layout: Nuxt Kit provides a set of utilities to help you work with layouts.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/layout.md

• Head: Nuxt Kit provides utilities to help you manage head configuration in modules.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/head.md

• Plugins: Nuxt Kit provides a set of utilities to help you create and use plugins. You can add plugins or plugin templates to your module using these functions.

  • URL: https://nuxt.com/raw/docs/3.x/api/kit/plugins.md

• Lifecycle Hooks: Nuxt provides a powerful hooking system to expand almost every aspect using hooks.

  • URL: https://nuxt.com/raw/docs/3.x/api/advanced/hooks.md

• Import meta: Understand where your code is running using import.meta.

  • URL: https://nuxt.com/raw/docs/3.x/api/advanced/import-meta.md

• Nuxt Configuration: Discover all the options you can use in your nuxt.config.ts file.

  • URL: https://nuxt.com/raw/docs/3.x/api/nuxt-config.md

• Nuxt API Reference: Explore all Nuxt Internals: Components, Composables, Utils, Commands and more.

  • URL: https://nuxt.com/raw/docs/3.x/api.md

• Hello World: A minimal Nuxt application only requires the app.vue and nuxt.config.js files.

  • URL: https://nuxt.com/raw/docs/3.x/examples/hello-world.md

• Auto Imports: This example demonstrates the auto-imports feature in Nuxt.

  • URL: https://nuxt.com/raw/docs/3.x/examples/features/auto-imports.md

• Data Fetching: This example demonstrates data fetching with Nuxt using built-in composables and API routes.

  • URL: https://nuxt.com/raw/docs/3.x/examples/features/data-fetching.md

• State Management: This example shows how to use the useState composable to create a reactive and SSR-friendly shared state across components.

  • URL: https://nuxt.com/raw/docs/3.x/examples/features/state-management.md

• Meta Tags: This example shows how to use the Nuxt helpers and composables for SEO and meta management.

  • URL: https://nuxt.com/raw/docs/3.x/examples/features/meta-tags.md

• Layouts: This example shows how to define default and custom layouts.

  • URL: https://nuxt.com/raw/docs/3.x/examples/features/layouts.md

• Middleware: This example shows how to add route middleware with the middleware/ directory or with a plugin, and how to use them globally or per page.

  • URL: https://nuxt.com/raw/docs/3.x/examples/routing/middleware.md

• Pages: This example shows how to use the pages/ directory to create application routes.

  • URL: https://nuxt.com/raw/docs/3.x/examples/routing/pages.md

• Universal Router: This example demonstrates Nuxt universal routing utilities without depending on pages/ and vue-router.

  • URL: https://nuxt.com/raw/docs/3.x/examples/routing/universal-router.md

• Layers: This example shows how to use the extends key in nuxt.config.ts.

  • URL: https://nuxt.com/raw/docs/3.x/examples/advanced/config-extends.md

• Error Handling: This example shows how to handle errors in different contexts: pages, plugins, components and middleware.

  • URL: https://nuxt.com/raw/docs/3.x/examples/advanced/error-handling.md

• JSX / TSX: This example shows how to use JSX syntax with typescript in Nuxt pages and components.

  • URL: https://nuxt.com/raw/docs/3.x/examples/advanced/jsx.md

• Locale: This example shows how to define a locale composable to handle the application's locale, both server and client side.

  • URL: https://nuxt.com/raw/docs/3.x/examples/advanced/locale.md

• Module Extend Pages: This example defines a new test page using extendPages within a module.

  • URL: https://nuxt.com/raw/docs/3.x/examples/advanced/module-extend-pages.md

• Teleport: This example shows how to use the with client-side and server-side rendering.

  • URL: https://nuxt.com/raw/docs/3.x/examples/advanced/teleport.md

• Testing: This example shows how to test your Nuxt application.

  • URL: https://nuxt.com/raw/docs/3.x/examples/advanced/testing.md

• useCookie: This example shows how to use the useCookie API to persist small amounts of data that both client and server can use.

  • URL: https://nuxt.com/raw/docs/3.x/examples/advanced/use-cookie.md

• Use Custom Fetch Composable: This example shows a convenient wrapper for the useFetch composable from nuxt. It allows you to customize the fetch request with default values and user authentication token.

  • URL: https://nuxt.com/raw/docs/3.x/examples/advanced/use-custom-fetch-composable.md

• WASM: This example demonstrates the server-side support of WebAssembly in Nuxt.

  • URL: https://nuxt.com/raw/docs/3.x/examples/experimental/wasm.md

• Getting Help: We're a friendly community of developers and we'd love to help.

  • URL: https://nuxt.com/raw/docs/3.x/community/getting-help.md

• Reporting Bugs: One of the most valuable roles in open source is taking the time to report bugs helpfully.

  • URL: https://nuxt.com/raw/docs/3.x/community/reporting-bugs.md

• Contribution: Nuxt is a community project - and so we love contributions of all kinds! ❤️

  • URL: https://nuxt.com/raw/docs/3.x/community/contribution.md

• Framework: Some specific points about contributions to the framework repository.

  • URL: https://nuxt.com/raw/docs/3.x/community/framework-contribution.md

• Roadmap: Nuxt is constantly evolving, with new features and modules being added all the time.

  • URL: https://nuxt.com/raw/docs/3.x/community/roadmap.md

• Releases: Discover the latest releases of Nuxt & Nuxt official modules.

  • URL: https://nuxt.com/raw/docs/3.x/community/changelog.md

• Overview: Reduce the differences with Nuxt 3 and reduce the burden of migration to Nuxt 3.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/overview.md

• Configuration: Learn how to configure Nuxt Bridge to your own needs.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/configuration.md

• TypeScript: Learn how to use TypeScript with Nuxt Bridge.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/typescript.md

• Legacy Composition API: Learn how to migrate to Composition API with Nuxt Bridge.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/bridge-composition-api.md

• Plugins and Middleware: Learn how to migrate from Nuxt 2 to Nuxt Bridge new plugins and middleware.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/plugins-and-middleware.md

• New Composition API: Nuxt Bridge implements composables compatible with Nuxt 3.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/nuxt3-compatible-api.md

• Meta Tags: Learn how to migrate from Nuxt 2 to Nuxt Bridge new meta tags.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/meta.md

• Runtime Config: Nuxt provides a runtime config API to expose configuration and secrets within your application.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/runtime-config.md

• Nitro: Activate Nitro to your Nuxt 2 application with Nuxt Bridge.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/nitro.md

• Vite: Activate Vite to your Nuxt 2 application with Nuxt Bridge.

  • URL: https://nuxt.com/raw/docs/3.x/bridge/vite.md

• Overview: Nuxt 3 is a complete rewrite of Nuxt 2, and also based on a new set of underlying technologies.

  • URL: https://nuxt.com/raw/docs/3.x/migration/overview.md

• Build Tooling: Learn how to migrate from Nuxt 2 to Nuxt 3 build tooling.

  • URL: https://nuxt.com/raw/docs/3.x/migration/bundling.md

• Server: Learn how to migrate from Nuxt 2 to Nuxt 3 server.

  • URL: https://nuxt.com/raw/docs/3.x/migration/server.md

• Configuration: Learn how to migrate from Nuxt 2 to Nuxt 3 new configuration.

  • URL: https://nuxt.com/raw/docs/3.x/migration/configuration.md

• Modules: Learn how to migrate from Nuxt 2 to Nuxt 3 modules.

  • URL: https://nuxt.com/raw/docs/3.x/migration/module-authors.md

• Auto Imports: Nuxt 3 adopts a minimal friction approach, meaning wherever possible components and composables are auto-imported.

  • URL: https://nuxt.com/raw/docs/3.x/migration/auto-imports.md

• Meta Tags: Manage your meta tags, from Nuxt 2 to Nuxt 3.

  • URL: https://nuxt.com/raw/docs/3.x/migration/meta.md

• Plugins and Middleware: Learn how to migrate from Nuxt 2 to Nuxt 3 plugins and middleware.

  • URL: https://nuxt.com/raw/docs/3.x/migration/plugins-and-middleware.md

• Pages and Layouts: Learn how to migrate from Nuxt 2 to Nuxt 3 pages and layouts.

  • URL: https://nuxt.com/raw/docs/3.x/migration/pages-and-layouts.md

• Component Options: Learn how to migrate from Nuxt 2 components options to Nuxt 3 composables.

  • URL: https://nuxt.com/raw/docs/3.x/migration/component-options.md

• Runtime Config: Learn how to migrate from Nuxt 2 to Nuxt 3 runtime config.

  • URL: https://nuxt.com/raw/docs/3.x/migration/runtime-config.md

• Nuxt Docs: This repository contains the documentation of Nuxt hosted on https://nuxt.com/docs

  • URL: https://nuxt.com/raw/docs/3.x/readme.md

Blog

• Announcing 3.0: We are thrilled to announce the first stable version of Nuxt 3.0.0

  • URL: https://nuxt.com/raw/blog/v3.md

• Nuxt 3.3: The 3.3.0 is a minor (feature) release with lots of performance and DX improvements, bug fixes and new features to play with.

  • URL: https://nuxt.com/raw/blog/v3-3.md

• Nuxt 3.4: Nuxt 3.4.0 is the latest release of Nuxt 3, bringing exciting new features, including support for the View Transitions API, transferring rich JavaScript payloads from server to client - and much more.

  • URL: https://nuxt.com/raw/blog/v3-4.md

• Nuxt 3.5: Nuxt 3.5.0 is out, bringing Vue 3.3, new defaults, interactive server components, typed pages, environment config - and much more.

  • URL: https://nuxt.com/raw/blog/v3-5.md

• Nuxt 3.6: Nuxt 3.6 is out, bringing performance improvements, fully static server components, better style inlining, static presets, increased type safety - and much more.

  • URL: https://nuxt.com/raw/blog/v3-6.md

• Nuxt on the Edge: Learn how we made Nuxt 3 capable of running on edge runtimes to run with server-side rendering close to your users.

  • URL: https://nuxt.com/raw/blog/nuxt-on-the-edge.md

• Nuxt 3.7: Nuxt 3.7 is out, bringing a new CLI, native web streams and response, rendering optimisations, async context support - and much more.

  • URL: https://nuxt.com/raw/blog/v3-7.md

• A New Website: We are thrilled to release the new nuxt.com, powered by Nuxt UI and now open source.

  • URL: https://nuxt.com/raw/blog/new-website.md

• Nuxt 3.8: Nuxt 3.8 is out, bringing built-in DevTools, automatic Nuxt Image install, a new app manifest and much more.

  • URL: https://nuxt.com/raw/blog/v3-8.md

• Nuxt DevTools v1.0: Nuxt DevTools v1.0 is out, generally available to all Nuxt projects!

  • URL: https://nuxt.com/raw/blog/nuxt-devtools-v1-0.md

• Nuxt 3.9: Nuxt 3.9 is out - a Christmas gift from the Nuxt team bringing Vite 5, interactive server components, new composables, a new loading API and more.

  • URL: https://nuxt.com/raw/blog/v3-9.md

• Nuxt: A vision for 2023: This past year has been an exciting one. Looking into the new year, there is a lot we have planned as a team and we'd love to share it with you.

  • URL: https://nuxt.com/raw/blog/vision-2023.md

• Nuxt 3.10: Nuxt 3.10 is out - packed with features and fixes. Here are a few highlights.

  • URL: https://nuxt.com/raw/blog/v3-10.md

• The Evolution of Shiki v1.0: Shiki v1.0 came with many improvements and features - see how Nuxt drives the evolution of Shiki!

  • URL: https://nuxt.com/raw/blog/shiki-v1.md

• Nuxt 3.11: Nuxt 3.11 is out - with better logging, preview mode, server pages and much more!

  • URL: https://nuxt.com/raw/blog/v3-11.md

• Nuxt: Looking forward: A lot of things have happened for Nuxt over the last year. Sébastien and Daniel share their thoughts on what we've achieved, and where we're going next.

  • URL: https://nuxt.com/raw/blog/looking-forward-2024.md

• Refreshed Nuxt ESLint Integrations: We revamped our ESLint integrations to support ESLint v9 with the flat config, as well as a new module with many more capabilities.

  • URL: https://nuxt.com/raw/blog/eslint-module.md

• Nuxt 3.12: Nuxt 3.12 is out - full of improvements and preparing the way for Nuxt 4!

  • URL: https://nuxt.com/raw/blog/v3-12.md

• Introducing Nuxt Scripts: Nuxt Scripts provides better performance, privacy, security, and developer experience for third-party scripts.

  • URL: https://nuxt.com/raw/blog/nuxt-scripts.md

• Nuxt 3.13: Nuxt 3.13 is out - porting back some of the new features we're building for Nuxt 4!

  • URL: https://nuxt.com/raw/blog/v3-13.md

• Nuxt 3.14: Nuxt 3.14 is out - with a new rspack builder, shared folder, and performance enhancements!

  • URL: https://nuxt.com/raw/blog/v3-14.md

• Introducing Nuxt Icon v1: Discover Nuxt Icon v1 - a modern, versatile, and customizable icon solution for your Nuxt projects.

  • URL: https://nuxt.com/raw/blog/nuxt-icon-v1-0.md

• Introducing Nuxt DevTools: Unleash the Developer Experience with Nuxt and understand your app better than ever.

  • URL: https://nuxt.com/raw/blog/introducing-nuxt-devtools.md

• Announcing Nuxt 3 Release Candidate: Nuxt 3 beta was announced on October 12, 2021 after 16 months of work, introducing a new foundation based on Vue 3, Vite and Nitro. Six months later, we are happy to announce the first release candidate of Nuxt 3, code named “Mount Hope“ 🚀

  • URL: https://nuxt.com/raw/blog/nuxt3-rc.md

• Nuxt 3.15: Nuxt 3.15 is out - with Vite 6, better HMR and faster performance

  • URL: https://nuxt.com/raw/blog/v3-15.md

• Nuxt 3.16: Nuxt 3.16 is out - packed with features and performance improvements

  • URL: https://nuxt.com/raw/blog/v3-16.md

• Nuxt UI v3: Nuxt UI v3 is out! After 1500+ commits, this major redesign brings improved accessibility, Tailwind CSS v4 support, and full Vue compatibility

  • URL: https://nuxt.com/raw/blog/nuxt-ui-v3.md

• Nuxt 3.17: Nuxt 3.17 is out - bringing a major reworking of the async data layer, a new built-in component, better warnings, and performance improvements!

  • URL: https://nuxt.com/raw/blog/v3-17.md

• Roadmap to v4: We have some exciting news about the roadmap to Nuxt 4, including a new timeline and what to expect in the next few weeks.

  • URL: https://nuxt.com/raw/blog/roadmap-v4.md

• Building a Privacy-First Feedback Widget: A lightweight, privacy-focused widget to gather your feedback on Nuxt documentation, built with Drizzle, NuxtHub database and Motion Vue.

  • URL: https://nuxt.com/raw/blog/building-a-feedback-widget.md

• Announcing Nuxt 4.0: Nuxt 4.0 is here! A thoughtful evolution focused on developer experience, with better project organization, smarter data fetching, and improved type safety.

  • URL: https://nuxt.com/raw/blog/v4.md

• Nuxt 3.18: Nuxt 3.18 is out - bringing v4 features to v3, improved accessibility, better browser dev tooling integration, and performance enhancements!

  • URL: https://nuxt.com/raw/blog/v3-18.md

• Nuxt 4.1: Nuxt 4.1 is out - bringing enhanced build stability, better development experience, and powerful new features for module authors!

  • URL: https://nuxt.com/raw/blog/v4-1.md

• Nuxt UI v4: Nuxt UI v4 unifies Nuxt UI and Nuxt UI Pro into one powerful, completely free library. With over 110 components, 12 templates, and a comprehensive Figma kit, all of this is available for free.

  • URL: https://nuxt.com/raw/blog/nuxt-ui-v4.md

• Nuxt 2 End-of-Life (EOL): Nuxt 2 will reach End of Life (EOL) on June 30th, 2024. We've partnered with HeroDevs on offering Never-Ending Support (NES).

  • URL: https://nuxt.com/raw/blog/nuxt2-eol.md

• Introducing Nuxt 3 Beta: 468 days after the first commit, the Nuxt 3 beta has finally arrived. Discover what's inside and what to expect from it. Yes, it includes Vue 3 and Vite ⚡️

  • URL: https://nuxt.com/raw/blog/nuxt3-beta.md

• Building an MCP Server for Nuxt: How we built the Nuxt MCP server to enable AI assistants to access our documentation through structured data and composable tools.

  • URL: https://nuxt.com/raw/blog/building-nuxt-mcp.md

• Nuxt 4.2: Nuxt 4.2 is out - with experimental TypeScript plugin support, better error handling in development, abort control for data fetching, and more!

  • URL: https://nuxt.com/raw/blog/v4-2.md

• Nuxt Image v2: Nuxt Image v2 is out - with full TypeScript support, IPX v3, and new providers!

  • URL: https://nuxt.com/raw/blog/nuxt-image-v2.md

• Nuxt 4.3: Nuxt 4.3 is out – route rule layouts, ISR payload extraction, draggable error overlay, and more!

  • URL: https://nuxt.com/raw/blog/v4-3.md

• Going Full Static: Long awaited features for JAMstack fans has been shipped in v2.13: full static export, improved smart prefetching, integrated crawler, faster re-deploy, built-in web server and new target option for config ⚡️

  • URL: https://nuxt.com/raw/blog/going-full-static.md

• Introducing Smart Prefetching: Starting from Nuxt v2.4.0, Nuxt will automagically prefetch the code-splitted pages linked with a nuxt-link when visible in the viewport by default.

  • URL: https://nuxt.com/raw/blog/introducing-smart-prefetching.md

• Understanding how fetch works in Nuxt 2.12: Explore different features of the fetch hook and learn a brand new way to bring data into Nuxt applications.

  • URL: https://nuxt.com/raw/blog/understanding-how-fetch-works-in-nuxt-2-12.md

• Nuxt 2 Static Improvements: With Nuxt version 2.13, the full-static mode has been introduced. In addition, a new command nuxt export was added to pre-render your pages without triggering a webpack build with the goal to separate the rendering and build process. The only issue was that most Nuxt users weren't able to unleash the full potential of the separation... until now.

  • URL: https://nuxt.com/raw/blog/nuxt-static-improvements.md

• Nuxt 2: From Terminal to Browser: How we changed the developer experience to stop switching between the terminal and browser.

  • URL: https://nuxt.com/raw/blog/nuxtjs-from-terminal-to-browser.md

How to Use This Skill

Reference these resources when working with Nuxt Docs.