---
title: "Quick Module Setup Guide"
description: "A quick guide on which features are available on activating Nuxt SEO."
canonical_url: "https://nuxtseo.com/docs/nuxt-seo/guides/using-the-modules"
---

> Index of every page on this site: [llms.txt](https://nuxtseo.com/llms.txt)

## Introduction

Nuxt SEO bundles 9 modules via `@nuxtjs/seo`: Sitemap, Robots, OG Image, [Schema.org](http://Schema.org), Link Checker, SEO Utils, Site Config, AI Ready, and Skew Protection. Most work out-of-the-box, but you may need some configuration
depending on your site's requirements.

::note{icon="i-heroicons-information-circle"}
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#the-nuxtjsseo-module) 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/github/harlan-zw/nuxt-seo/tree/main/examples/basic) if you want to
see a working example.

## Sitemap

::module-card{slug="sitemap" .w-1/2}
::

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**: 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

::module-card{slug="robots" .w-1/2}
::

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>">`{lang="html"} 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**: 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

::module-card{slug="og-image" .w-1/2}
::

Generate dynamic Open Graph images for your pages.

- It needs a renderer dependency. If your app has no OG Image template and no renderer, OG images stay off. The module logs one line with the `enable` command.
- If a template needs a renderer that is not installed, `nuxt dev` in an interactive terminal asks before it installs anything. In CI and AI agent shells, it logs the install command instead.
- A production build fails when a page uses a template whose renderer is not installed.
- If OG Image signs URLs, production needs `NUXT_APP_SECRET`. See [URL Signing](https://nuxtseo.com/docs/og-image/guides/security#url-signing).
- 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.

If you want dynamic images, install a renderer:

```bash
npx nuxt-og-image enable takumi
```

If you don't intend to generate dynamic images, [disable this module](https://nuxtseo.com/docs/nuxt-seo/guides/disabling-modules) with `ogImage: false`{lang="ts"}.

## [Schema.org](http://Schema.org)

::module-card{slug="schema-org" .w-1/2}
::

Automatically generates [schema.org](http://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](http://Schema.org) using [useSchemaOrg](https://nuxtseo.com/docs/schema-org/guides/full-documentation).

## Link Checker

::module-card{slug="link-checker" .w-1/2}
::

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

::module-card{slug="seo-utils" .w-1/2}
::

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](http://Schema.org) support

## AI Ready

::module-card{slug="ai-ready" .w-1/2}
::

Makes your pages readable by AI agents.

- Serves [/llms.txt](http://localhost:3000/llms.txt) and a Markdown version of every page. A prerender also writes `/llms-full.txt`.
- Publishes Agent Skills from `public/skills/<name>/SKILL.md` in your project and layers. Files under the root `skills/` directory stay private.
- Generates an API catalog when you configure an MCP server and a site URL.
- Background indexing and cron stay off until you enable them. The database also stays off, unless an MCP server or WebMCP site tools need it.

To turn off Agent Skills or the API catalog, set `aiReady: { agentSkills: false }`{lang="ts"} or `aiReady: { apiCatalog: false }`{lang="ts"}.

See the [AI Ready docs](https://nuxtseo.com/docs/ai-ready/getting-started/introduction) for more information. If you don't want AI Ready, [disable this module](https://nuxtseo.com/docs/nuxt-seo/guides/disabling-modules) with `aiReady: false`{lang="ts"}.

## Skew Protection

::module-card{slug="skew-protection" .w-1/2}
::

Keeps the assets of earlier builds available after a deploy. Open tabs and crawlers stop hitting `ChunkLoadError` and 404 errors on old chunks.

Nuxt SEO changes two Skew Protection defaults:

- `updateStrategy: 'polling'`{lang="ts"}: it checks for new versions with Nuxt's app manifest polling, so it opens no persistent connection.
- `cookie: false`{lang="ts"}: it sets no version cookie. Connection, route, and IP tracking also stay off.

Your `skewProtection` options take precedence over these defaults.

Skew Protection stores old assets in `node_modules/.cache/nuxt-seo/skew-protection`. If your CI starts from a clean checkout, cache that directory between builds, or set `skewProtection.storage`. Without that history, the module cannot keep the assets of earlier deployments.

If a server handler calls `isClientOutdated()`{lang="ts"}, set `skewProtection.cookie` to a cookie config object.

See the [Skew Protection docs](https://nuxtseo.com/docs/skew-protection/getting-started/introduction) for more information. If you don't want Skew Protection, [disable this module](https://nuxtseo.com/docs/nuxt-seo/guides/disabling-modules) with `skewProtection: false`{lang="ts"}.

## Shared Configuration

::module-card{slug="site-config" .w-1/2}
::

[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.

::note{icon="i-heroicons-information-circle"}
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` or `nuxt-i18n-micro`)

```ts twoslash [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 or nuxt-i18n-micro installed
  }
})
```

**I18n features**: 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.

## Sitemap

See the full [sitemap](https://nuxtseo.com/sitemap.md) for all pages.
