Nuxt on Netlify
Nuxt is an open source, modular framework for building performant sites and applications using Vue.js.
# Key features
These Nuxt features provide key benefits for sites and apps, including ones built and deployed with Netlify.
- Improved SEO. With the ability to statically generate your site, Nuxt can help to boost search engine optimization for your content.
- Page routing. Nuxt has a file system-based routing structure. Organizing files and subdirectories within a pages directory automatically results in corresponding routes.
- Image optimization. The
nuxt/imagemodule allows you to automatically optimize images for your site.
- Git-based Headless CMS. The
nuxt/contentmodule parses Markdown, JSON, YAML, XML and CSV files within your site.
- Server-side rendering. Powered by the Nitro server engine, SSR is supported automatically when you use Nuxt 3.
# Netlify integration
Nuxt sites on Netlify can benefit from automatic framework detection and require minimal setup considerations.
Nuxt 3 introduces new rendering options, such as server-side rendering (SSR). SSR is supported when you deploy Nuxt 3 to Netlify, but requires configuration when you use Edge Functions.
For more information, check out the Nuxt Getting Started Guide and Deploy Nuxt to Netlify doc.
# Automatic framework detection
When you link a repository for a project, Netlify tries to detect the framework your site is using.
If your site is built with Nuxt, Netlify provides a suggested build command and publish directory:
- Nuxt 2:
- Nuxt 3:
npm run build(assuming your build command is set to
nuxt build) and
If you’re using the CLI to run Netlify Dev for a local development environment, the CLI should work automatically assuming you are using the dev command and port:
3000. You can override suggested values or set them in a configuration file instead, but automatic framework detection may help simplify the process of setting up a site on Netlify.
For manual configuration, check out the typical build settings for Nuxt.
# Setup considerations
When setting up a statically-generated Nuxt 2 site for deployment on Netlify, ensure the following:
- If you’re using
create-nuxt-appto generate a new Nuxt project, make these selections:
- Rendering mode:
Universal (SSR / SSG)(the default)
- Deployment target:
Static (Static/JAMstack hosting)
- Rendering mode:
- If you have an existing Nuxt project, the project’s
nuxt.config.jsfile must contain
For single-page applications with client side rendering, refer to the Nuxt documentation for configuration information.
# pnpm support
If you’re planning to use pnpm with Nuxt 3, you must set a
PNPM_FLAGS environment variable with a value of
--shamefully-hoist. This appends an argument to the
pnpm install command that Netlify runs. Learn more about using pnpm on Netlify.
# Edge Functions
Edge Functions connect the Netlify platform and workflow with an open runtime standard at the network edge. This enables you to build fast, personalized web experiences with an ecosystem of development tools.
Nuxt supports server-side rendering (SSR), but the use of Edge Functions requires some configuration. When you use Edge Functions, Nitro, the server engine that powers Nuxt, will not auto-detect them and needs a different deployment preset. Learn more in the Nitro documentation.
You can browse a full library of reference examples for different ways to use Edge Functions. For more details, check out the Edge Functions documentation.
# More resources
Did you find this doc useful?
Your feedback helps us improve our docs.