Skip to content

harlan-zw/nuxt-seo

@nuxtjs/seo

npm version npm downloads License Nuxt

Fully equipped Technical SEO for busy Nuxters.

Nuxt SEO is an ecosystem of SEO modules, tools, and tutorials built with and for the Nuxt community. Technical SEO requires many moving parts: sitemaps, robots.txt, Schema.org, OG images, meta tags, broken links. Nuxt SEO provides a module for each, so you can install them individually or all at once.

Made possible by my Sponsor Program πŸ’–
Follow me @harlan_zw 🐦 β€’ Join Discord for help

Features

  • πŸ€– Crawl Control: Automatic robots.txt generation, <meta name="robots"> tags, and X-Robots-Tag headers to manage how search engines access your site.
  • πŸ“„ Sitemaps: Auto-generated sitemap.xml from your app's data sources, with multi-sitemap support for i18n sites.
  • πŸ–ΌοΈ OG Images: Dynamic Open Graph image generation for every page, no manual design work needed.
  • πŸ”Ž Structured Data: Schema.org JSON-LD generated automatically with sensible defaults and opt-in rich schemas.
  • βœ… Link Checking: Broken link detection at build time with ESLint integration and DevTools support.
  • β–³ SEO Utils: Automatic favicons, default meta tags, breadcrumbs, and social share links.

The @nuxtjs/seo Module

The @nuxtjs/seo package is a simple alias for installing all of the modules in one go.

// This is all it does!
export default defineNuxtModule<ModuleOptions>({
  moduleDependencies: {
    '@nuxtjs/robots': { version: '>=6.0' },
    '@nuxtjs/sitemap': { version: '>=8.0' },
    'nuxt-link-checker': { version: '>=5.0' },
    'nuxt-og-image': { version: '>=6.2' },
    'nuxt-schema-org': { version: '>=6.0' },
    'nuxt-seo-utils': { version: '>=8.1' },
    'nuxt-site-config': { version: '>=4.0' },
  },
})

Every module works standalone. Install @nuxtjs/seo to get everything at once, or pick only what you need (e.g. Sitemap and Robots). Configuration, composables, and features are identical either way.

Modules

Module Package What it solves
Robots @nuxtjs/robots Search engines need clear instructions about which pages to crawl and index
Sitemap @nuxtjs/sitemap Search engines can't discover all your pages without a structured index
OG Image nuxt-og-image Social platforms need preview images when content is shared
Schema.org nuxt-schema-org Rich snippets and search features require structured data
SEO Utils nuxt-seo-utils Favicons, default meta, breadcrumbs, and other SEO essentials
Link Checker nuxt-link-checker Broken links harm SEO and user experience
Site Config nuxt-site-config All modules need consistent site URL, name, and locale config

Note

Site Config installs automatically with any SEO module. It provides a unified configuration layer that works across all modules at both build time and runtime.

Installation

Install everything at once:

npx nuxt module add seo

Or pick only what you need:

npx nuxt module add sitemap robots

Tip

Generate an Agent Skill for this package using skilld:

npx skilld add @nuxtjs/seo

Once installed, check the Using the Modules guide to get started.

Going Further

Modules handle the technical foundation, but testing your production environment is as important. Nuxt SEO provides free tools to validate your live site:

Learn more about SEO beyond the technical basics:

Documentation

Read the full documentation for configuration options, guides, and examples.

Sponsors

License

Licensed under the MIT license.

About

Fully equipped Technical SEO for busy Nuxters.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors