Config · Nuxt SEO Utils · 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/seo-utils/getting-started/introduction)

[API](https://nuxtseo.com/docs/seo-utils/api/breadcrumbs)

[Releases](https://nuxtseo.com/docs/seo-utils/releases/v8)

SEO Utils

- [Switch to SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [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 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`` /`

v8.1.7

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

### Nuxt API

- [`useBreadcrumbItems()`](https://nuxtseo.com/docs/seo-utils/api/breadcrumbs)
- [`useFallbackTitle()`](https://nuxtseo.com/docs/seo-utils/api/fallback-title)
- [`useShareLinks()`](https://nuxtseo.com/docs/seo-utils/api/share-links)
- [nuxt.config.ts](https://nuxtseo.com/docs/seo-utils/api/config)

Nuxt API

# Config

[Copy for LLMs](https://nuxtseo.com/docs/seo-utils/api/config.md)

### [`enabled`](#enabled)

- Type: `boolean`
- Default: `true`

Conditionally toggle the module.

### [`debug`](#debug)

- Type: `boolean`
- Default: `false`

Enables debug logs.

## [`canonicalQueryWhitelist`](#canonicalquerywhitelist)

- Type: `string[]`
- Default: `['page', 'sort', 'filter', 'search', 'q', 'category', 'tag']`

When set, only these query parameters are included in the canonical URL. All other query parameters are stripped.

## [`canonicalLowercase`](#canonicallowercase)

- Type: `boolean`
- Default: `true`

When enabled, the canonical URL will be lowercased. Recommended to keep on for consistency.

## [`redirectToCanonicalSiteUrl`](#redirecttocanonicalsiteurl)

- Type: `boolean`
- Default: `false`

When enabled, it will redirect any request to the canonical domain (site url) using a 301 redirect on non-dev environments.

E.g if the site url is ' [www.example.com](http://www.example.com)' and the user visits 'example.com', they will be redirected to ' [www.example.com](http://www.example.com)'.

This is useful for SEO as it prevents duplicate content and consolidates page rank.

## [`automaticDefaults`](#automaticdefaults)

- Type: `boolean`
- Default: `true`

Will set up a number of defaults for meta tags and Schema.org, if the modules and config are available.

## [`mergeWithSiteConfig`](#mergewithsiteconfig)

- Type: `boolean`
- Default: `true`

Injects site config into the `useHead` composable such as setting the title template and template params like `%siteName`.

## [`fallbackTitle`](#fallbacktitle)

- Type: `boolean`
- Default: `true`

Will ensure a title is always set by providing a fallback title based on the casing the last slug segment.

## [`metaDataFiles`](#metadatafiles)

- Type: `boolean`
- Default: `true`

Should the files in the public directory be used to infer tags such as favicon, apple-touch-icon, and open graph images.

## [`automaticOgAndTwitterTags`](#automaticogandtwittertags)

- Type: `boolean`
- Default: `true`

Should head data be inferred from the current input to fill in the gaps.

For example:

- If you supply a title, this will automatically add an og:title.
- If you provide an og:image, it will automatically add a twitter:image.

## [`tagPriority`](#tagpriority)

- Type: `number | 'critical' | 'high' | 'low' | \`before:${string}` | `after:${string}``{lang="ts"}
- Default: `'low'`

Sets the `tagPriority` for SEO and Open Graph meta tags generated by this module. The default `'low'` ensures module tags act as fallbacks that page-level `useSeoMeta()` calls can override. Use a numeric value or `'critical'`/`'high'` to place tags earlier in the `<head>` (useful for OG crawlers with byte limits).

## [`minify`](#minify)

- Type: `boolean| { build?: boolean, runtime?: boolean }`
- Default: `true`

Minifies inline `<script>` and `<style>` tags in SSR responses. Both modes can be toggled independently.

**Build mode** (`build`): Minifies static scripts and styles in `app.head` and prerendered route HTML at build time using Rolldown/esbuild (JS) and lightningcss (CSS).

**Runtime mode** (`runtime`): Minifies all inline scripts and styles per request via an Unhead `ssr:render` plugin. Uses lightweight pure JS minifiers with zero native dependencies. Handles dynamic content like hydration payloads and `useHead()` injections.

Both (default)

Build only

Runtime only

```
seo: { minify: true }
```

```
seo: { minify: { build: true, runtime: false } }
```

```
seo: { minify: { runtime: true, build: false } }
```

JSON script types (`application/ld+json`, `application/json`) are minified via JSON round-tripping. `importmap` and `speculationrules` types are left untouched. Only active in production builds.

## [`treeShakeUseSeoMeta`](#treeshakeuseseometa)

- Type: `boolean`
- Default: `true`

Attempts to treeshake the `useSeoMeta` function. Can save around 5kb in the client bundle.

## [`extendRouteRules`](#extendrouterules)

- Type: `boolean`
- Default: `true`

Adds `head` and `seoMeta` to the route rules and app config.

## [`fixRequiredAbsoluteMetaTagsLinks`](#fixrequiredabsolutemetatagslinks)

- Type: `boolean`
- Default: `true`

Tries to convert relative image paths to absolute paths in meta tags.

## [`extendNuxtConfigAppHeadSeoMeta`](#extendnuxtconfigappheadseometa)

- Type: `boolean`
- Default: `true`

Extends `app.head` with the `seoMeta` key.

## [`extendNuxtConfigAppHeadTypes`](#extendnuxtconfigappheadtypes)

- Type: `boolean`
- Default: `true`

Augments the head schema with `/public` files making it easier to reference them in the head.

## [`meta`](#meta)

- Type: `MetaFlatSerializable`
- Default: `{}`

The SEO meta object to be used as site-wide defaults. Takes the same input as `useSeoMeta()`. See the [Nuxt Config SEO Meta](https://nuxtseo.com/docs/seo-utils/guides/nuxt-config-seo-meta) guide for details.

## [`setupNuxtConfigAppHeadWithMoreDefaults`](#setupnuxtconfigappheadwithmoredefaults)

- Type: `boolean`
- Default: `true`

Sets up additional default head values in your nuxt.config app.head section.

[Edit this page](https://github.com/harlan-zw/nuxt-seo-utils/edit/main/docs/content/3.api/0.config.md)

[Markdown For LLMs](https://nuxtseo.com/docs/seo-utils/api/config.md)

Did this page help you?

[Inline Minification Automatically minify inline scripts and styles in your SSR responses to reduce page weight.](https://nuxtseo.com/docs/seo-utils/guides/minification) [useBreadcrumbItems() A composable used to display a breadcrumb list that helps users to navigate between pages.](https://nuxtseo.com/docs/seo-utils/api/breadcrumbs)

On this page

- [enabled](#enabled)
- [debug](#debug)
- [canonicalQueryWhitelist](#canonicalquerywhitelist)
- [canonicalLowercase](#canonicallowercase)
- [redirectToCanonicalSiteUrl](#redirecttocanonicalsiteurl)
- [automaticDefaults](#automaticdefaults)
- [mergeWithSiteConfig](#mergewithsiteconfig)
- [fallbackTitle](#fallbacktitle)
- [metaDataFiles](#metadatafiles)
- [automaticOgAndTwitterTags](#automaticogandtwittertags)
- [tagPriority](#tagpriority)
- [minify](#minify)
- [treeShakeUseSeoMeta](#treeshakeuseseometa)
- [extendRouteRules](#extendrouterules)
- [fixRequiredAbsoluteMetaTagsLinks](#fixrequiredabsolutemetatagslinks)
- [extendNuxtConfigAppHeadSeoMeta](#extendnuxtconfigappheadseometa)
- [extendNuxtConfigAppHeadTypes](#extendnuxtconfigappheadtypes)
- [meta](#meta)
- [setupNuxtConfigAppHeadWithMoreDefaults](#setupnuxtconfigappheadwithmoredefaults)

[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 "Nuxt SEO Pro")

- [Getting Started](https://nuxtseo.com/pro)
- [Dashboard](https://nuxtseo.com/pro/dashboard)
- [Pro MCP](https://nuxtseo.com/pro/docs/getting-started/mcp-setup)

### [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 Idea Generator](https://nuxtseo.com/tools/keyword-generator)
- [Keyword Research](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings](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)