@nuxtjs/robots

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

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 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.

Features

- 🤖 Merge in your existing robots.txt or programmatically create a new one
- 🗿 Automatic X-Robots-Tag header and 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:

``bash
npx nuxi@latest module add robots
``

💡 Need a complete SEO solution for Nuxt? Check out Nuxt SEO.

Documentation

📖 Read the full documentation for more information.

Demos

- Default - StackBlitz

Sponsors

License

Licensed under the MIT license.

[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/robots/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxtjs/robots

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/robots.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/robots

[license-src]: https://img.shields.io/github/license/nuxt-modules/robots.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://github.com/nuxt-modules/robots/blob/main/LICENSE.md

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com