Quick Module Setup Guide · Nuxt SEO

[NuxtSEO](https://nuxtseo.com/ "Home")

- [Modules](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Tools](https://nuxtseo.com/tools)
- [Pro](https://nuxtseo.com/pro)
- [Learn SEO](https://nuxtseo.com/learn-seo/nuxt) [Releases](https://nuxtseo.com/releases)

[1.4K](https://github.com/harlan-zw/nuxt-seo)

[Nuxt SEO on GitHub](https://github.com/harlan-zw/nuxt-seo)

[User Guides](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)

[Releases](https://nuxtseo.com/docs/nuxt-seo/releases/v5)

Nuxt SEO

- [Switch to Nuxt SEO](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Switch to Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Switch to Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [Switch to OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Switch to Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Switch to Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [Switch to SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Switch to Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Switch to Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [Switch to AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

Search…```k`` /`

v5.1.0

- Playgrounds
- [Discord Support](https://discord.com/invite/275MBUBvgP)

### Getting Started

- [Introduction](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Installation](https://nuxtseo.com/docs/nuxt-seo/getting-started/installation)
- [Troubleshooting](https://nuxtseo.com/docs/nuxt-seo/getting-started/troubleshooting)
- [Community Videos](https://nuxtseo.com/docs/nuxt-seo/getting-started/community-videos)

### Core Concepts

- [Quick Module Setup Guide](https://nuxtseo.com/docs/nuxt-seo/guides/using-the-modules)
- [Disabling Modules](https://nuxtseo.com/docs/nuxt-seo/guides/disabling-modules)
- [Nuxt Content](https://nuxtseo.com/docs/nuxt-seo/guides/nuxt-content)
- [MCP Server](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)
- [LLMs.txt](https://nuxtseo.com/docs/nuxt-seo/guides/llms-txt)
- [Understanding Site Config](https://nuxtseo.com/docs/nuxt-seo/guides/site-config)
- [Debugging Modules](https://nuxtseo.com/docs/nuxt-seo/guides/debugging-modules)
- [Updating Nuxt Modules](https://nuxtseo.com/docs/nuxt-seo/guides/updating-modules)

Core Concepts

# Quick Module Setup Guide

[Copy for LLMs](https://nuxtseo.com/docs/nuxt-seo/guides/using-the-modules.md)

## [Introduction](#introduction)

Nuxt SEO bundles 6 core modules via `@nuxtjs/seo`. Most work out-of-the-box, but you may need some configuration depending on your site's requirements. Additional standalone modules like [Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction) and [AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction) can be installed separately.

Whether you installed `@nuxtjs/seo` (the alias) or individual modules, the configuration is the same. Each module is independent and configured through its own options. See [the introduction](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction#nuxtjsseo-vs-individual-modules) for details.

This guide will give you a quick overview of each module and what you need to do to get started.

Check out the [StackBlitz Demo](https://stackblitz.com/edit/nuxt-starter-gfrej6?file=nuxt.config.ts) if you want to see a working example.

## [Sitemap](#sitemap)

[Sitemap v8.0.1110M421 Powerfully flexible XML Sitemaps that integrate seamlessly.](https://nuxtseo.com/docs/sitemap/getting-started/introduction)

Generates a [sitemap](https://developers.google.com/search/docs/crawling-indexing/sitemaps/overview) at [/sitemap.xml](http://localhost:3000/sitemap.xml) based on your app [data sources](https://nuxtseo.com/docs/sitemap/getting-started/data-sources).

- When prerendering or using static only routes, it will automatically generate a sitemap for you without any configuration.
- If you have dynamic routes, you'll need to set up a handler for [Dynamic URLs](https://nuxtseo.com/docs/sitemap/guides/dynamic-urls).

### [I18n Features](#i18n-features)

The sitemap module will automatically generate a multi sitemap with each locale having its own sitemap.

See [I18n Sitemap](https://nuxtseo.com/docs/sitemap/guides/i18n) for more information.

## [Robots](#robots)

[Robots v6.0.68.8M516 Tame the robots crawling and indexing your site with ease.](https://nuxtseo.com/docs/robots/getting-started/introduction)

Generates a [robots.txt](https://developers.google.com/search/docs/crawling-indexing/robots/intro) at [/robots.txt](http://localhost:3000/robots.txt).

Will append a `<meta name="robots" content="<rule>">` and a `X-Robots-Tag` HTTP header.

- If you have any other environments besides development and production, you need to configure the `env` option. See the [Disabling Indexing](https://nuxtseo.com/docs/robots/guides/disable-indexing) guide for more information.
- By default, all routes are allowed for all user-agents. See [Disabling Page Indexing](https://nuxtseo.com/docs/robots/guides/disable-page-indexing) to start blocking routes.

### [I18n Features](#i18n-features-1)

Any `Disallow` rules in the robots module will automatically have the locale prefixes added.

See [I18n Robots](https://nuxtseo.com/docs/robots/advanced/i18n) for more information.

## [OG Image](#og-image)

[OG Image v6.3.23.7M534 Generate OG Images with Vue templates in Nuxt.](https://nuxtseo.com/docs/og-image/getting-started/introduction)

Generate dynamic Open Graph images for your pages.

- Opt-in, by default, it won't do anything unless you configure it.
- See the [Tutorial: Getting Familiar With Nuxt OG Image](https://nuxtseo.com/docs/og-image/getting-started/getting-familiar-with-nuxt-og-image) docs on setting it up.

Note: If you don't intend to generate dynamic images, it's recommended to [disable this module](https://nuxtseo.com/docs/nuxt-seo/guides/disabling-modules).

## [Schema.org](#schemaorg)

[Schema.org v6.0.43.9M185 The quickest and easiest way to build Schema.org graphs.](https://nuxtseo.com/docs/schema-org/getting-started/introduction)

Automatically generates schema.org JSON-LD for your pages.

- Provides [default Schema.org](https://nuxtseo.com/docs/schema-org/guides/default-schema-org) for your pages.
- It's recommended to [Setup Your Identity](https://nuxtseo.com/docs/schema-org/guides/setup-identity) for your site as well.
- You can opt in to more Schema.org using [useSchemaOrg](https://nuxtseo.com/docs/schema-org/guides/full-documentation).

## [Link Checker](#link-checker)

[Link Checker v5.0.72.8M99 Find and magically fix links that may be negatively effecting your SEO.](https://nuxtseo.com/docs/link-checker/getting-started/introduction)

Checks all links for issues that may be affecting your SEO.

- When building your site it will check links
- You can also run it manually by opening the "Link Checker" tab in Nuxt DevTools

## [SEO Utils](#seo-utils)

[SEO Utils v8.1.62.2M123 SEO utilities to improve your Nuxt sites discoverability and shareability.](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)

A few extra SEO Nuxt features that don't fit anywhere else.

- See the [SEO Utils Introduction](https://nuxtseo.com/docs/seo-utils/getting-started/introduction) for more information.
- Automatic File Metadata [Icons](https://nuxtseo.com/docs/seo-utils/guides/app-icons) and [Open Graph Images](https://nuxtseo.com/docs/seo-utils/guides/open-graph-images)
- Opt in [seoMeta](https://nuxtseo.com/docs/seo-utils/guides/nuxt-config-seo-meta) in your nuxt.config and route rules
- Automatic [default meta](https://nuxtseo.com/docs/seo-utils/guides/default-meta) for your site.
- Automatic [fallback title](https://nuxtseo.com/docs/seo-utils/guides/fallback-title) for your site.
- Opt-in [breadcrumbs](https://nuxtseo.com/docs/seo-utils/api/breadcrumbs) with Schema.org support

## [Shared Configuration](#shared-configuration)

[Site Config v4.0.711M78 Powerful build and runtime shared site configuration for Nuxt modules.](https://nuxtseo.com/docs/site-config/getting-started/introduction)

[Nuxt Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction) allows you to configure all Nuxt SEO modules at build time and runtime, for example in a multi-tenant or i18n app.

You do not need to install `nuxt-site-config` manually. It installs automatically with any Nuxt SEO module.

You should set the following config. Since v5, site config is no longer inferred from `package.json` or your project directory, so these values must be set explicitly:

- `url` - The canonical URL of your site, avoids duplicate content and consolidates page rank.
- `name` - The name of your site, used in the title and meta tags. **Required** if you want your site name in SEO output.
- `description` - The description of your site, used in the meta tags.
- `defaultLocale` - The default locale of your site, used in the meta tags. (you can omit this if you're using `@nuxtjs/i18n`)

nuxt.config.ts

```
export default defineNuxtConfig({
  site: {
    url: 'https://example.com',
    name: 'Awesome Site',
    description: 'Welcome to my awesome site!',
    defaultLocale: 'en', // not needed if you have @nuxtjs/i18n installed
  }
})
```

### [I18n Features](#i18n-features-2)

You can dynamically set the site config based on the current locale.

This is useful for setting the `url` and `name` properties based on the page the user is currently on.

See [I18n Site Config](https://nuxtseo.com/docs/site-config/guides/i18n) for more information.

[Edit this page](https://github.com/harlan-zw/nuxt-seo/edit/main/docs/content/2.guides/0.using-the-modules.md)

[Markdown For LLMs](https://nuxtseo.com/docs/nuxt-seo/guides/using-the-modules.md)

Did this page help you?

### Related

[Site Config](https://nuxtseo.com/docs/nuxt-seo/guides/site-config) [Nuxt Content](https://nuxtseo.com/docs/nuxt-seo/guides/nuxt-content) [Debugging Modules](https://nuxtseo.com/docs/nuxt-seo/guides/debugging-modules)

[Community Videos Learn from the Nuxt community in using Nuxt SEO.](https://nuxtseo.com/docs/nuxt-seo/getting-started/community-videos) [Disabling Modules Learn how to disable modules in Nuxt SEO.](https://nuxtseo.com/docs/nuxt-seo/guides/disabling-modules)

On this page

- [Introduction](#introduction)
- [Sitemap](#sitemap)
- [Robots](#robots)
- [OG Image](#og-image)
- [Schema.org](#schemaorg)
- [Link Checker](#link-checker)
- [SEO Utils](#seo-utils)
- [Shared Configuration](#shared-configuration)

[GitHub](https://github.com/harlan-zw/nuxt-seo) [ Discord](https://discord.com/invite/275MBUBvgP)

### [NuxtSEO](https://nuxtseo.com/ "Home")

- [Getting Started](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [MCP](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)

Modules

- [Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

### [NuxtSEO Pro](https://nuxtseo.com/pro "Home")

- [Getting Started](https://nuxtseo.com/pro)
- [Dashboard](https://nuxtseo.com/pro/dashboard)
- [Pro MCP](https://nuxtseo.com/docs/nuxt-seo-pro/mcp/installation)

### [Learn SEO](https://nuxtseo.com/learn-seo "Learn SEO")

Nuxt

- [Mastering Meta](https://nuxtseo.com/learn-seo/nuxt/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers)
- [Launch & Listen](https://nuxtseo.com/learn-seo/nuxt/launch-and-listen)
- [Routes & Rendering](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering)
- [Staying Secure](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering/security)

Vue

- [Vue SEO Guide](https://nuxtseo.com/learn-seo/vue)
- [Mastering Meta](https://nuxtseo.com/learn-seo/vue/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/vue/controlling-crawlers)
- [SPA SEO](https://nuxtseo.com/learn-seo/vue/spa)
- [SSR Frameworks](https://nuxtseo.com/learn-seo/vue/ssr-frameworks)
- [SEO Checklist](https://nuxtseo.com/learn-seo/checklist)
- [Pre-Launch Warmup](https://nuxtseo.com/learn-seo/pre-launch-warmup)
- [Backlinks & Authority](https://nuxtseo.com/learn-seo/backlinks)

### [Tools](https://nuxtseo.com/tools "SEO Tools")

- [Social Share Debugger](https://nuxtseo.com/tools/social-share-debugger)
- [Robots.txt Generator](https://nuxtseo.com/tools/robots-txt-generator)
- [Meta Tag Checker](https://nuxtseo.com/tools/meta-tag-checker)
- [HTML to Markdown](https://nuxtseo.com/tools/html-to-markdown)
- [XML Sitemap Validator](https://nuxtseo.com/tools/xml-sitemap-validator)
- [Schema.org Validator](https://nuxtseo.com/tools/schema-validator)
- [Keyword Research Pro](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer Pro](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings Pro](https://nuxtseo.com/tools/domain-rankings)

Copyright © 2023-2026 Harlan Wilton - [MIT License](https://github.com/harlan-zw/nuxt-seo/blob/main/license) · [mdream](https://mdream.dev)