Comprehensive guide for all 8 Nuxt SEO modules: @nuxtjs/seo, nuxt-robots, nuxt-sitemap, nuxt-og-image, nuxt-schema-org, nuxt-link-checker, nuxt-seo-utils, and nuxt-site-config. Use when building SEO-optimized Nuxt applications, implementing robots.txt and sitemaps, generating Open Graph images, adding Schema.org structured data, managing meta tags, checking links, or configuring site-wide SEO settings. Keywords: nuxt-seo, nuxt, seo, nuxt 3, nuxt 4, nuxt seo, vue, vue 3, search engine optimization, @nuxtjs/seo, nuxt-robots, nuxt-sitemap, nuxt-og-image, nuxt-schema-org, nuxt-link-checker, nuxt-seo-utils, nuxt-site-config, robots.txt, sitemap, sitemap.xml, og image, open graph, social sharing, meta tags, schema.org, structured data, json-ld, canonical urls, breadcrumbs, bot detection, crawling, indexing, noindex, nofollow, xml sitemap, multiple sitemaps, sitemap index, dynamic sitemap, og image generation, satori, chromium rendering, vue templates, seo setup, seo configuration, meta management, social media preview, search optimization, link checking, broken links, site config, multi-language seo, i18n seo, sitemap not generated, robots.txt missing, og image not rendering, schema validation errors, duplicate meta tags, canonical url issues, sitemap index errors
/plugin marketplace add secondsky/claude-skills/plugin install nuxt-seo@claude-skillsThis skill inherits all available tools. When active, it can use any tool Claude has access to.
assets/package-versions.jsonreferences/advanced-configuration.mdreferences/api-reference.mdreferences/best-practices.mdreferences/common-patterns.mdreferences/installation-guide.mdreferences/module-details.mdreferences/modules-overview.mdreferences/troubleshooting.mdscripts/init-nuxt-seo.shStatus: Production Ready Last Updated: 2025-11-27 Dependencies: Nuxt >=3.0.0 Latest Versions: See module versions table below
Use this skill when building SEO-optimized Nuxt applications with any combination of the 8 official Nuxt SEO modules. This skill covers the complete Nuxt SEO ecosystem maintained by Harlan Wilton.
Nuxt SEO consists of 8 specialized modules that work together seamlessly:
| Module | Version | Downloads | Purpose |
|---|---|---|---|
| @nuxtjs/seo | v3.2.2 | 1.8M | Primary SEO module (installs all 8 modules as bundle) |
| nuxt-robots | v5.5.6 | 7.1M | Manages robots.txt and bot detection |
| nuxt-sitemap | v7.4.7 | 8.6M | Generates XML sitemaps with advanced features |
| nuxt-og-image | v5.1.12 | 2.5M | Creates Open Graph images via Vue templates |
| nuxt-schema-org | v5.0.9 | 2.9M | Builds Schema.org structured data graphs |
| nuxt-link-checker | v4.3.6 | 2M | Finds and fixes broken links |
| nuxt-seo-utils | v7.0.18 | 1.1M | SEO utilities for discoverability & shareability |
| nuxt-site-config | v3.2.11 | 7.9M | Centralized site configuration management |
Requirements: Nuxt v3 or v4
Install all 8 modules at once:
# Using Bun (primary)
bunx nuxi module add @nuxtjs/seo
# Using npm (backup)
npx nuxi module add @nuxtjs/seo
# Using pnpm (backup)
pnpm dlx nuxi module add @nuxtjs/seo
Why this matters:
Add to nuxt.config.ts:
export default defineNuxtConfig({
modules: ['@nuxtjs/seo'],
site: {
url: 'https://example.com',
name: 'My Awesome Site',
description: 'Building amazing web experiences',
defaultLocale: 'en'
}
})
CRITICAL:
site.url to production URL (required for sitemaps and canonical URLs)defaultLocale if using i18nbun run dev
# or
npm run dev
Visit these URLs to verify:
http://localhost:3000/robots.txt - Robots filehttp://localhost:3000/sitemap.xml - Sitemapbunx nuxi module add @nuxtjs/seo
# or: npx nuxi module add @nuxtjs/seo
Configuration:
export default defineNuxtConfig({
modules: ['@nuxtjs/seo']
})
Install only what's needed:
# Bun
bunx nuxi module add nuxt-robots
bunx nuxi module add nuxt-sitemap
bunx nuxi module add nuxt-og-image
# npm
npx nuxi module add nuxt-robots
npx nuxi module add nuxt-sitemap
npx nuxi module add nuxt-og-image
# pnpm (backup)
pnpm dlx nuxi module add nuxt-robots
pnpm dlx nuxi module add nuxt-sitemap
pnpm dlx nuxi module add nuxt-og-image
Configuration:
export default defineNuxtConfig({
modules: [
'nuxt-robots',
'nuxt-sitemap',
'nuxt-og-image'
]
})
The Nuxt SEO ecosystem consists of 8 specialized modules that work together seamlessly. Each module serves a specific purpose and can be installed individually or as a complete bundle.
Primary SEO module that installs all 8 modules as a bundle. Provides unified configuration through the site object and integrates with Nuxt Content for automatic SEO.
Manages robots.txt and bot detection. Controls which pages search engines can crawl with site-wide and page-level rules. Includes server-side and client-side bot detection.
Generates XML sitemaps automatically from routes with support for dynamic URLs, multiple sitemaps, media, and advanced optimization. Perfect for large sites with thousands of pages.
Creates Open Graph images dynamically using Vue templates. Zero runtime overhead with Satori renderer or full CSS support with Chromium renderer.
Builds Schema.org structured data for enhanced search results with rich snippets, knowledge panels, and better SEO.
Finds and fixes links that may negatively affect SEO. Detects broken links, redirects, and issues during development and build.
SEO utilities for discoverability and shareability including canonical URLs, breadcrumbs, app icons, and Open Graph automation.
Centralized site configuration management for all SEO modules. Single source of truth for site-wide settings like URL, name, and locale.
For complete module documentation with configurations, APIs, and examples:
Load references/module-details.md when you need:
// nuxt.config.ts - Complete SEO setup
export default defineNuxtConfig({
modules: ['@nuxtjs/seo'],
site: {
url: 'https://example.com',
name: 'My Awesome Site',
defaultLocale: 'en'
},
robots: {
disallow: ['/admin']
},
sitemap: {
sitemaps: {
blog: { sources: ['/api/__sitemap__/blog'] }
}
}
})
For complete integration examples:
Load references/common-patterns.md when you need:
✅ Set site.url in nuxt.config.ts (required for sitemaps and canonical URLs)
✅ Use environment variables for multi-environment setups
✅ Configure robots.txt to block admin/private pages
✅ Add Schema.org structured data to all important pages
✅ Generate OG images for social sharing
✅ Test all SEO features before deploying to production
✅ Submit sitemap to Google Search Console after deployment
✅ Enable link checker during development
❌ Forget to set site.url (breaks sitemaps and canonical URLs)
❌ Allow crawling of staging environments
❌ Skip Schema.org for key pages (products, articles, events)
❌ Deploy without testing OG images
❌ Use outdated module versions
❌ Ignore broken links found by link checker
❌ Forget to exclude admin/private routes from sitemap
❌ Use wrong rendering engine for OG images (Chromium vs Satori)
This skill prevents 10 documented common SEO mistakes:
Error: /sitemap.xml returns 404
Why It Happens: Missing site.url configuration
Prevention: Always set site.url in nuxt.config.ts
Error: /robots.txt not accessible
Why It Happens: Module not installed or misconfigured
Prevention: Install nuxt-robots and set site.url
Error: /__og-image__/og.png returns error
Why It Happens: Incompatible CSS with Satori renderer
Prevention: Use Satori-compatible CSS or switch to Chromium renderer
Error: Invalid JSON-LD in page source Why It Happens: Incorrect Schema.org structure Prevention: Follow official Schema.org types and validate with Google's Rich Results Test
Error: 404 errors on internal links
Why It Happens: Links not updated after route changes
Prevention: Enable nuxt-link-checker during development
Error: Multiple meta tags with same property Why It Happens: Conflicting manual meta tags and module automation Prevention: Let modules handle meta tags automatically
Error: Wrong canonical URL in meta tags
Why It Happens: Incorrect site.url or missing trailing slash config
Prevention: Configure site.url and trailingSlash correctly
Error: Sitemap index XML malformed
Why It Happens: Too many URLs in single sitemap
Prevention: Use chunksSize option to split large sitemaps
Error: Staging site indexed by Google
Why It Happens: No robots.txt blocking
Prevention: Configure robots to block staging: disallow: process.env.NUXT_PUBLIC_ENV === 'staging' ? ['/'] : []
Error: No preview image when sharing on social media
Why It Happens: OG image not defined or not accessible
Prevention: Use defineOgImage() on all important pages
export default defineNuxtConfig({
modules: ['@nuxtjs/seo'],
site: {
url: process.env.NUXT_PUBLIC_SITE_URL,
name: 'My Site',
defaultLocale: 'en'
},
robots: {
disallow: process.env.NUXT_PUBLIC_ENV === 'staging' ? ['/'] : []
},
sitemap: {
sitemaps: {
blog: { sources: ['/api/__sitemap__/blog'] }
}
}
})
For complete configuration examples:
Load references/advanced-configuration.md when you need:
init-nuxt-seo.sh - Quick setup script for new projects
./scripts/init-nuxt-seo.sh
Automatically:
Load the appropriate reference file based on the user's specific needs:
Load references/modules-overview.md when:
Load references/installation-guide.md when:
Load references/api-reference.md when:
Load references/common-patterns.md when:
New references (to be created in Phase 13):
Load references/module-details.md when:
Load references/best-practices.md when:
Load references/troubleshooting.md when:
Load references/advanced-configuration.md when:
Current references:
references/modules-overview.md - Detailed overview of all 8 modulesreferences/installation-guide.md - Step-by-step installation patternsreferences/api-reference.md - Complete API documentation for all composablesreferences/common-patterns.md - Real-world usage patterns and examplesassets/package-versions.json - Current module versions for verification1. Always Set Site Config
site: {
url: process.env.NUXT_PUBLIC_SITE_URL,
name: 'Your Site Name'
}
2. Block Staging from Search Engines
robots: {
disallow: process.env.NUXT_PUBLIC_ENV === 'staging' ? ['/'] : []
}
3. Add Schema.org to All Pages Every page should have appropriate structured data (Organization, BlogPosting, Product, etc.).
For complete best practices guide:
Load references/best-practices.md when you need:
1. Sitemap Not Generating
nuxt-sitemap is installedsite.url in config/sitemap.xml2. OG Images Not Rendering
nuxt-og-image is installed3. Build Errors
.nuxt and node_modules/.cacherm -rf node_modules && bun installFor complete troubleshooting guide:
Load references/troubleshooting.md when you need:
{
"dependencies": {
"@nuxtjs/seo": "^3.2.2",
"nuxt-robots": "^5.5.6",
"nuxt-sitemap": "^7.4.7",
"nuxt-og-image": "^5.1.12",
"nuxt-schema-org": "^5.0.9",
"nuxt-link-checker": "^4.3.6",
"nuxt-seo-utils": "^7.0.18",
"nuxt-site-config": "^3.2.11"
}
}
Use this checklist to verify setup:
site.url in nuxt.config.tssite.name and site.descriptiondefaultLocale if using i18n/robots.txt endpoint/sitemap.xml endpointProduction Ready: All patterns based on official documentation from https://nuxtseo.com/llms.txt | Last verified: 2025-11-10
v1.1.0 (2025-11-27)
v1.0.0 (2025-11-10)
Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.