@nuxtjs/robots

@nuxtjs/robots

Nuxt Robots is a module for configuring the robots crawling your site with minimal config and best practice defaults.

The core feature of the module is:

• Telling crawlers which paths they can and cannot access using a robots.txt file.
• Telling search engine crawlers what they can show in search results from your site using a <meta name="robots" content="index"> X-Robots-Tag HTTP header.

New to robots or SEO? Check out the Controlling Web Crawlers guide to learn more about why you might need these features.

Made possible by my Sponsor Program 💖 Follow me @harlan_zw 🐦 • Join Discord for help

Features

• 🤖 Merge in your existing robots.txt or programmatically create a new one
• 🗿 Automatic X-Robots-Tag header and <meta name="robots" ...> meta tag
• 🕵️ Bot detection with optional fingerprinting
• 🔒 Disables non-production environments from being indexed
• 🤠 Control AI crawlers using the Content-Signal and Content-Usage directives

Installation

💡 Using Nuxt 2? Please use the v3.x tag.

Install @nuxtjs/robots dependency to your project:

npx nuxt module add robots

[!TIP] Using an AI agent? Get the @nuxtjs/robots Skill on skilld.dev/gh/nuxt-modules/robots.

💡 Configured your robots.txt? Verify what crawlers and AI bots can access with the free Robots.txt Validator, or monitor crawl & indexing status with Nuxt SEO Pro.

Documentation

📖 Read the full documentation for more information.

Demos

• Default - StackBlitz

Sponsors

License

Licensed under the MIT license.