PluginBench
Skill
Pass
Audit score 90

nuxt-seo

onmax/nuxt-skills

Nuxt SEO meta-module for robots.txt, sitemaps, OG images, and structured data.

What is nuxt-seo?

A comprehensive Nuxt module that handles SEO configuration, robots.txt and sitemap generation, dynamic OG image creation, and JSON-LD structured data. Use it when setting up SEO foundations, generating search-engine metadata, or adding rich content previews to your Nuxt site.

  • Configure site-wide SEO settings (URL, name, indexability) via nuxt-site-config
  • Generate robots.txt and sitemap.xml automatically with customizable rules
  • Create dynamic Open Graph images for social sharing
  • Add JSON-LD structured data (schema.org) for rich snippets
  • Generate breadcrumbs and canonical URLs
  • Validate internal links at build time

How to install nuxt-seo

npx skills add https://github.com/onmax/nuxt-skills --skill nuxt-seo
Prerequisites
  • Nuxt 3 project
  • @nuxtjs/seo module installed via `npx nuxi module add @nuxtjs/seo`
Claude Code
Cursor
Windsurf
Cline

How to use nuxt-seo

  1. 1.Install the module: `npx nuxi module add @nuxtjs/seo`
  2. 2.Configure site settings in `nuxt.config.ts` under the `site` property
  3. 3.Load relevant reference files based on your task (site-config, crawlability, og-image, schema-org, or utilities)
  4. 4.Use composables like `useSiteConfig()`, `useRobotsRule()`, `defineOgImage()`, or `useSchemaOrg()` in your pages/components
  5. 5.For Nuxt Content v3, use `asSeoCollection()` to automatically apply SEO metadata from frontmatter

Use cases

Good for
  • Setting up SEO configuration and site metadata for a new Nuxt project
  • Generating dynamic OG images for blog posts or product pages
  • Creating structured data (schema.org) for e-commerce or article content
  • Automating sitemap and robots.txt generation for search engine crawling
  • Integrating SEO metadata from Nuxt Content v3 frontmatter automatically
Who it's for
  • Nuxt developers building SEO-critical sites
  • Content creators using Nuxt Content for blogs or documentation
  • E-commerce teams needing structured product data
  • Teams automating search engine optimization workflows

nuxt-seo FAQ

Do I need to load all reference files?

No. Load only the files relevant to your current task to keep token usage efficient. Each sub-file is 400–600 tokens.

How do I use this with Nuxt Content?

Use `asSeoCollection()` in your content.config.ts to automatically generate sitemaps, OG images, and structured data from frontmatter. Ensure @nuxtjs/seo is loaded before @nuxt/content in the modules array.

What composables are available?

Key composables include `useSiteConfig()` for site config, `useRobotsRule()` for robots rules, `defineOgImage()` for OG images, `useSchemaOrg()` for JSON-LD, and `useBreadcrumbItems()` for breadcrumbs.

Can I customize robots.txt and sitemap.xml?

Yes. Use `useRobotsRule()` and `defineSitemapEventHandler()` to customize rules and entries dynamically.

Does this validate links?

Yes. The nuxt-link-checker module included performs build-time validation of internal links.

Full instructions (SKILL.md)

Source of truth, from onmax/nuxt-skills.


name: nuxt-seo description: Nuxt SEO meta-module with robots, sitemap, og-image, schema-org. Use when configuring SEO, generating sitemaps, creating OG images, or adding structured data. license: MIT

Nuxt SEO

npx nuxi module add @nuxtjs/seo

When to Use

Working with:

  • SEO configuration (site URL, name, indexability)
  • Robots.txt and sitemap.xml generation
  • Dynamic OG image generation
  • JSON-LD structured data (schema.org)
  • Breadcrumbs and canonical URLs

Loading Files

Consider loading these reference files based on your task:

DO NOT load all files at once. Load only what's relevant to your current task.

Site Config

Foundation for all SEO modules. Configure site in nuxt.config.ts, access via useSiteConfig(). See references/site-config.md for full options.

Module Overview

ModulePurposeKey API
nuxt-site-configShared configuseSiteConfig()
@nuxtjs/robotsrobots.txtuseRobotsRule()
@nuxtjs/sitemapsitemap.xmldefineSitemapEventHandler()
nuxt-og-imageOG imagesdefineOgImage()
nuxt-schema-orgJSON-LDuseSchemaOrg()
nuxt-seo-utilsMeta utilitiesuseBreadcrumbItems()
nuxt-link-checkerLink validationBuild-time checks

Nuxt Content v3

Use asSeoCollection() for automatic sitemap, og-image, and schema-org from frontmatter:

// content.config.ts
import { defineCollection, defineContentConfig } from '@nuxt/content'
import { asSeoCollection } from '@nuxtjs/seo/content'

export default defineContentConfig({
  collections: {
    posts: defineCollection(asSeoCollection({ type: 'page', source: 'posts/**' }))
  }
})

Important: Load @nuxtjs/seo before @nuxt/content in modules array:

export default defineNuxtConfig({
  modules: ['@nuxtjs/seo', '@nuxt/content']
})

Frontmatter fields: ogImage, sitemap, robots, schemaOrg.

Related Skills

  • nuxt-content - For MDC rendering with SEO frontmatter

Links

Token Efficiency

Main skill: ~250 tokens. Each sub-file: ~400-600 tokens. Only load files relevant to current task.