# Nuxt ## Docs - [Code Style Guide](https://mintlify.wiki/nuxt/nuxt/advanced/code-style.md): Nuxt supports ESLint out of the box for maintaining consistent code style across your application. - [ES Modules](https://mintlify.wiki/nuxt/nuxt/advanced/esm.md): Nuxt uses native ES modules to provide better performance and modern JavaScript features. - [Nuxt Kit Overview](https://mintlify.wiki/nuxt/nuxt/advanced/kit.md): @nuxt/kit provides features for module authors to interact with Nuxt programmatically. - [Nuxt Lifecycle](https://mintlify.wiki/nuxt/nuxt/advanced/nuxt-lifecycle.md): Understanding the lifecycle of Nuxt applications can help you gain deeper insights into how the framework operates, especially for both server-side and client-side rendering. - [Vue.js Development](https://mintlify.wiki/nuxt/nuxt/advanced/vuejs-development.md): Nuxt uses Vue.js and adds features such as component auto-imports, file-based routing and composables for an SSR-friendly usage. - [nuxt analyze](https://mintlify.wiki/nuxt/nuxt/api/commands/analyze.md): Analyze the production bundle or your Nuxt application. - [nuxt build](https://mintlify.wiki/nuxt/nuxt/api/commands/build.md): Build your Nuxt application. - [nuxt cleanup](https://mintlify.wiki/nuxt/nuxt/api/commands/cleanup.md): Remove common generated Nuxt files and caches. - [nuxt dev](https://mintlify.wiki/nuxt/nuxt/api/commands/dev.md): The dev command starts a development server with hot module replacement at http://localhost:3000 - [nuxt devtools](https://mintlify.wiki/nuxt/nuxt/api/commands/devtools.md): The devtools command allows you to enable or disable Nuxt DevTools on a per-project basis. - [nuxt generate](https://mintlify.wiki/nuxt/nuxt/api/commands/generate.md): Pre-renders every route of the application and stores the result in plain HTML files. - [create nuxt](https://mintlify.wiki/nuxt/nuxt/api/commands/init.md): The init command initializes a fresh Nuxt project. - [nuxt prepare](https://mintlify.wiki/nuxt/nuxt/api/commands/prepare.md): The prepare command creates a .nuxt directory in your application and generates types. - [nuxt preview](https://mintlify.wiki/nuxt/nuxt/api/commands/preview.md): The preview command starts a server to preview your application after the build command. - [nuxt typecheck](https://mintlify.wiki/nuxt/nuxt/api/commands/typecheck.md): The typecheck command runs vue-tsc to check types throughout your app. - [nuxt upgrade](https://mintlify.wiki/nuxt/nuxt/api/commands/upgrade.md): The upgrade command upgrades Nuxt to the latest version. - [](https://mintlify.wiki/nuxt/nuxt/api/components/client-only.md): Render components only in client-side with the component. - [](https://mintlify.wiki/nuxt/nuxt/api/components/dev-only.md): Render components only during development with the component. - [](https://mintlify.wiki/nuxt/nuxt/api/components/nuxt-error-boundary.md): The component handles client-side errors happening in its default slot. - [](https://mintlify.wiki/nuxt/nuxt/api/components/nuxt-img.md): Nuxt provides a component to handle automatic image optimization. - [](https://mintlify.wiki/nuxt/nuxt/api/components/nuxt-island.md): Nuxt provides the component to render a non-interactive component without any client JS. - [](https://mintlify.wiki/nuxt/nuxt/api/components/nuxt-layout.md): Nuxt provides the component to show layouts on pages and error pages. - [](https://mintlify.wiki/nuxt/nuxt/api/components/nuxt-link.md): Nuxt provides component to handle any kind of links within your application. - [](https://mintlify.wiki/nuxt/nuxt/api/components/nuxt-loading-indicator.md): Display a progress bar between page navigations. - [](https://mintlify.wiki/nuxt/nuxt/api/components/nuxt-page.md): The component is required to display pages located in the pages/ directory. - [](https://mintlify.wiki/nuxt/nuxt/api/components/nuxt-picture.md): Nuxt provides a component to handle automatic image optimization. - [](https://mintlify.wiki/nuxt/nuxt/api/components/teleports.md): The component teleports a component to a different location in the DOM. - [useAppConfig](https://mintlify.wiki/nuxt/nuxt/api/composables/use-app-config.md): Access the reactive app config defined in the project. - [useAsyncData](https://mintlify.wiki/nuxt/nuxt/api/composables/use-async-data.md): useAsyncData provides access to data that resolves asynchronously in an SSR-friendly composable. - [useCookie](https://mintlify.wiki/nuxt/nuxt/api/composables/use-cookie.md): useCookie is an SSR-friendly composable to read and write cookies. - [useError](https://mintlify.wiki/nuxt/nuxt/api/composables/use-error.md): useError composable returns the global Nuxt error that is being handled. - [useFetch](https://mintlify.wiki/nuxt/nuxt/api/composables/use-fetch.md): Fetch data from an API endpoint with an SSR-friendly composable. - [useHead](https://mintlify.wiki/nuxt/nuxt/api/composables/use-head.md): useHead customizes the head properties of individual pages of your Nuxt app. - [useHeadSafe](https://mintlify.wiki/nuxt/nuxt/api/composables/use-head-safe.md): The recommended way to provide head data with user input. - [useHydration](https://mintlify.wiki/nuxt/nuxt/api/composables/use-hydration.md): Allows full control of the hydration cycle to set and receive data from the server. - [useLazyAsyncData](https://mintlify.wiki/nuxt/nuxt/api/composables/use-lazy-async-data.md): This wrapper around useAsyncData triggers navigation immediately. - [useLazyFetch](https://mintlify.wiki/nuxt/nuxt/api/composables/use-lazy-fetch.md): This wrapper around useFetch triggers navigation immediately. - [useLoadingIndicator](https://mintlify.wiki/nuxt/nuxt/api/composables/use-loading-indicator.md): This composable gives you access to the loading state of the app page. - [useNuxtApp](https://mintlify.wiki/nuxt/nuxt/api/composables/use-nuxt-app.md): Access the shared runtime context of the Nuxt Application. - [useNuxtData](https://mintlify.wiki/nuxt/nuxt/api/composables/use-nuxt-data.md): Access the current cached value of data fetching composables. - [useRequestEvent](https://mintlify.wiki/nuxt/nuxt/api/composables/use-request-event.md): Access the incoming request event with the useRequestEvent composable. - [useRequestHeaders](https://mintlify.wiki/nuxt/nuxt/api/composables/use-request-headers.md): Use useRequestHeaders to access the incoming request headers. - [Builder](https://mintlify.wiki/nuxt/nuxt/api/kit/builder.md): Builder utilities to extend Vite and webpack configurations - [Compatibility](https://mintlify.wiki/nuxt/nuxt/api/kit/compatibility.md): Compatibility utilities to help you check Nuxt version compatibility - [Components](https://mintlify.wiki/nuxt/nuxt/api/kit/components.md): Component utilities to help you work with components - [Context](https://mintlify.wiki/nuxt/nuxt/api/kit/context.md): Context utilities to access the Nuxt instance - [Logging](https://mintlify.wiki/nuxt/nuxt/api/kit/logging.md): Logging utilities to help you work with logging - [Modules](https://mintlify.wiki/nuxt/nuxt/api/kit/modules.md): Module utilities for creating and using Nuxt modules - [Nitro](https://mintlify.wiki/nuxt/nuxt/api/kit/nitro.md): Nitro utilities to add server handlers, plugins, and prerender routes - [Pages](https://mintlify.wiki/nuxt/nuxt/api/kit/pages.md): Pages utilities to manipulate pages configuration and define route rules - [Plugins](https://mintlify.wiki/nuxt/nuxt/api/kit/plugins.md): Plugin utilities to add plugins or plugin templates - [Programmatic Usage](https://mintlify.wiki/nuxt/nuxt/api/kit/programmatic.md): Programmatic utilities for working with Nuxt - [Resolving](https://mintlify.wiki/nuxt/nuxt/api/kit/resolving.md): Resolving utilities to help you resolve paths - [Templates](https://mintlify.wiki/nuxt/nuxt/api/kit/templates.md): Template utilities to generate extra files during development and build time - [nuxt.config.ts](https://mintlify.wiki/nuxt/nuxt/api/nuxt-config.md): Complete reference for Nuxt configuration options in nuxt.config.ts - [abortNavigation](https://mintlify.wiki/nuxt/nuxt/api/utils/abort-navigation.md): Prevent navigation from taking place and throw an error if one is set as a parameter. - [$fetch](https://mintlify.wiki/nuxt/nuxt/api/utils/dollarfetch.md): Nuxt uses ofetch to expose globally the $fetch helper for making HTTP requests. - [navigateTo](https://mintlify.wiki/nuxt/nuxt/api/utils/navigate-to.md): Programmatically navigate users to pages. - [Utils Overview](https://mintlify.wiki/nuxt/nuxt/api/utils/overview.md): Nuxt provides a comprehensive set of utility functions for navigation, data management, and component handling. - [prefetchComponents](https://mintlify.wiki/nuxt/nuxt/api/utils/prefetch-components.md): Nuxt provides utilities to give you control over prefetching components. - [preloadComponents](https://mintlify.wiki/nuxt/nuxt/api/utils/preload-components.md): Nuxt provides utilities to give you control over preloading components. - [preloadRouteComponents](https://mintlify.wiki/nuxt/nuxt/api/utils/preload-route-components.md): Manually preload individual pages in your Nuxt app. - [refreshNuxtData](https://mintlify.wiki/nuxt/nuxt/api/utils/refresh-nuxt-data.md): Refresh all or specific asyncData instances in Nuxt. - [reloadNuxtApp](https://mintlify.wiki/nuxt/nuxt/api/utils/reload-nuxt-app.md): Perform a hard reload of the page. - [setPageLayout](https://mintlify.wiki/nuxt/nuxt/api/utils/set-page-layout.md): Dynamically change the layout of a page. - [Composition API in Bridge](https://mintlify.wiki/nuxt/nuxt/bridge/composition-api.md): Learn how to migrate from legacy Composition API packages to Nuxt Bridge's built-in Composition API support. - [Bridge Configuration](https://mintlify.wiki/nuxt/nuxt/bridge/configuration.md): Learn how to configure Nuxt Bridge to enable specific features and customize your migration experience. - [Bridge Overview](https://mintlify.wiki/nuxt/nuxt/bridge/overview.md): Reduce the differences with Nuxt 3 and reduce the burden of migration by using Nuxt Bridge. - [TypeScript in Bridge](https://mintlify.wiki/nuxt/nuxt/bridge/typescript.md): Learn how to enable and use TypeScript with Nuxt Bridge for better type safety and developer experience. - [Changelog](https://mintlify.wiki/nuxt/nuxt/community/changelog.md): Discover the latest releases of Nuxt and official Nuxt modules. - [Contribution](https://mintlify.wiki/nuxt/nuxt/community/contribution.md): Learn how you can contribute to the Nuxt ecosystem and help make it better for everyone. - [Framework Contribution](https://mintlify.wiki/nuxt/nuxt/community/framework-contribution.md): Learn how to contribute to the Nuxt framework repository and help improve the core. - [Getting Help](https://mintlify.wiki/nuxt/nuxt/community/getting-help.md): Join our friendly community of developers who are ready to help you solve any issues you encounter. - [Reporting Bugs](https://mintlify.wiki/nuxt/nuxt/community/reporting-bugs.md): Learn how to report bugs effectively to help improve Nuxt for everyone. - [Roadmap](https://mintlify.wiki/nuxt/nuxt/community/roadmap.md): Discover what's coming next for Nuxt with our roadmap and development status reports. - [Auto-Imports](https://mintlify.wiki/nuxt/nuxt/concepts/auto-imports.md): Learn how Nuxt automatically imports components, composables, helper functions, and Vue APIs across your application. - [Data Fetching with Composables](https://mintlify.wiki/nuxt/nuxt/concepts/data-fetching.md): Learn how to fetch data in Nuxt using useFetch, useAsyncData, and $fetch composables. - [Module System](https://mintlify.wiki/nuxt/nuxt/concepts/modules.md): Learn about Nuxt's module system that extends the framework core and simplifies integrations. - [File-Based Routing](https://mintlify.wiki/nuxt/nuxt/concepts/routing.md): Learn how Nuxt's file-system router automatically creates routes from files in the pages directory. - [Nitro Server Engine](https://mintlify.wiki/nuxt/nuxt/concepts/server-engine.md): Learn about Nitro, the powerful server engine that powers Nuxt applications. - [Server-Side Rendering](https://mintlify.wiki/nuxt/nuxt/concepts/server-side-rendering.md): Learn about Nuxt's rendering modes including universal rendering, client-side rendering, and hybrid rendering. - [State Management](https://mintlify.wiki/nuxt/nuxt/concepts/state-management.md): Learn how to manage state in Nuxt using useState composable and third-party libraries like Pinia. - [TypeScript Support](https://mintlify.wiki/nuxt/nuxt/concepts/typescript.md): Learn how Nuxt provides full TypeScript support with auto-generated types and helpful type-checking features. - [Views and Templates](https://mintlify.wiki/nuxt/nuxt/concepts/views.md): Learn how to structure your application's user interface with app.vue, components, pages, and layouts in Nuxt. - [Configuration](https://mintlify.wiki/nuxt/nuxt/configuration.md): Nuxt is configured with sensible defaults to make you productive. - [Deployment Overview](https://mintlify.wiki/nuxt/nuxt/deployment/deployment.md): Learn how to deploy your Nuxt application to any hosting provider, from Node.js servers to static hosting and edge environments. - [Edge and Serverless Deployment](https://mintlify.wiki/nuxt/nuxt/deployment/edge-deployment.md): Deploy your Nuxt application to edge networks and serverless platforms for global distribution with minimal latency. - [Node.js Server Deployment](https://mintlify.wiki/nuxt/nuxt/deployment/node-server.md): Deploy your Nuxt application to Node.js hosting environments with full server-side rendering capabilities. - [Prerendering and Static Site Generation](https://mintlify.wiki/nuxt/nuxt/deployment/prerendering.md): Learn how to prerender your Nuxt application at build time for improved performance and SEO using static site generation (SSG). - [Static Hosting](https://mintlify.wiki/nuxt/nuxt/deployment/static-hosting.md): Deploy your Nuxt application to static hosting services using pre-rendering or static site generation (SSG). - [app.vue](https://mintlify.wiki/nuxt/nuxt/directory-structure/app.md): The app.vue file is the main component of your Nuxt application. - [components/](https://mintlify.wiki/nuxt/nuxt/directory-structure/components.md): The components/ directory is where you put all your Vue components. - [composables/](https://mintlify.wiki/nuxt/nuxt/directory-structure/composables.md): Use the composables/ directory to auto-import your Vue composables into your application. - [layouts/](https://mintlify.wiki/nuxt/nuxt/directory-structure/layouts.md): Nuxt provides a layouts framework to extract common UI patterns into reusable layouts. - [middleware/](https://mintlify.wiki/nuxt/nuxt/directory-structure/middleware.md): Nuxt provides middleware to run code before navigating to a particular route. - [modules/](https://mintlify.wiki/nuxt/nuxt/directory-structure/modules.md): Use the modules/ directory to automatically register local modules within your application. - [nuxt.config.ts](https://mintlify.wiki/nuxt/nuxt/directory-structure/nuxt-config.md): Nuxt can be easily configured with a single nuxt.config file. - [Directory Structure Overview](https://mintlify.wiki/nuxt/nuxt/directory-structure/overview.md): Learn about the directory structure of a Nuxt application and how to organize your code effectively. - [pages/](https://mintlify.wiki/nuxt/nuxt/directory-structure/pages.md): Nuxt provides file-based routing to create routes within your web application. - [plugins/](https://mintlify.wiki/nuxt/nuxt/directory-structure/plugins.md): Nuxt has a plugins system to use Vue plugins and more at the creation of your Vue application. - [public/](https://mintlify.wiki/nuxt/nuxt/directory-structure/public.md): The public/ directory is used to serve your website's static assets. - [server/](https://mintlify.wiki/nuxt/nuxt/directory-structure/server.md): The server/ directory is used to register API and server handlers to your application. - [Asset Handling](https://mintlify.wiki/nuxt/nuxt/guide/assets.md): Learn how to manage static assets and build-processed files in your Nuxt application using the public and assets directories. - [Error Handling](https://mintlify.wiki/nuxt/nuxt/guide/error-handling.md): Learn how to catch and handle errors across different contexts in your Nuxt application. - [Layers Feature](https://mintlify.wiki/nuxt/nuxt/guide/layers.md): Extend your Nuxt application with the powerful layers system to share components, utilities, and configuration across projects. - [SEO and Meta Tags](https://mintlify.wiki/nuxt/nuxt/guide/seo-meta.md): Manage your Nuxt app's SEO with powerful head configuration, composables, and components powered by Unhead. - [Styling Options](https://mintlify.wiki/nuxt/nuxt/guide/styling.md): Learn how to style your Nuxt application with CSS, preprocessors, frameworks, and modern styling solutions. - [Testing Guide](https://mintlify.wiki/nuxt/nuxt/guide/testing.md): Learn how to test your Nuxt application with unit tests, component tests, and end-to-end testing using @nuxt/test-utils. - [Page and Layout Transitions](https://mintlify.wiki/nuxt/nuxt/guide/transitions.md): Apply smooth transitions between pages and layouts using Vue's Transition component or native browser View Transitions. - [Installation](https://mintlify.wiki/nuxt/nuxt/installation.md): Get started with Nuxt quickly with online starters or start locally with your terminal. - [Introduction](https://mintlify.wiki/nuxt/nuxt/introduction.md): Nuxt's goal is to make web development intuitive and performant with a great Developer Experience in mind. - [Auto-imports Migration](https://mintlify.wiki/nuxt/nuxt/migration/auto-imports.md): Nuxt 3 adopts a minimal friction approach, meaning components and composables are auto-imported wherever possible. - [Configuration Migration](https://mintlify.wiki/nuxt/nuxt/migration/configuration.md): Learn how to migrate your Nuxt 2 configuration to Nuxt 3's new configuration system. - [Meta Tags Migration](https://mintlify.wiki/nuxt/nuxt/migration/meta.md): Learn how to migrate your meta tags from Nuxt 2 to Nuxt 3's new meta management system. - [Migration Overview](https://mintlify.wiki/nuxt/nuxt/migration/overview.md): Migrate your Nuxt 2 app to Nuxt 3 with this comprehensive guide covering Vue 3, Vite, and Nitro. - [Pages and Layouts Migration](https://mintlify.wiki/nuxt/nuxt/migration/pages-and-layouts.md): Learn how to migrate your Nuxt 2 pages and layouts to Nuxt 3's new structure. - [Plugins and Middleware Migration](https://mintlify.wiki/nuxt/nuxt/migration/plugins-and-middleware.md): Learn how to migrate your Nuxt 2 plugins and middleware to Nuxt 3's new format. - [Runtime Config Migration](https://mintlify.wiki/nuxt/nuxt/migration/runtime-config.md): Learn how to migrate from environment variables to Nuxt 3's runtime config system. - [Create Your First Module](https://mintlify.wiki/nuxt/nuxt/modules/authoring-guide.md): Learn how to create your first Nuxt module using the official starter template. - [Follow Best Practices](https://mintlify.wiki/nuxt/nuxt/modules/best-practices.md): Build performant and maintainable Nuxt modules with these guidelines. - [Module Author Guide](https://mintlify.wiki/nuxt/nuxt/modules/introduction.md): Learn how to create a Nuxt module to integrate, enhance or extend any Nuxt applications. - [Understand Module Structure](https://mintlify.wiki/nuxt/nuxt/modules/module-anatomy.md): Learn how Nuxt modules are structured and how to define them. - [Module Recipes](https://mintlify.wiki/nuxt/nuxt/modules/recipes.md): Learn how to inject plugins, components, composables and server routes from your module.