https://github.com/nuxt-modules/robots

Tame the robots crawling and indexing your Nuxt site.
https://github.com/nuxt-modules/robots

nuxt nuxt-module robots-txt ssr vuejs

Last synced: 5 days ago
JSON representation

Tame the robots crawling and indexing your Nuxt site.

• Host: GitHub
• URL: https://github.com/nuxt-modules/robots
• Owner: nuxt-modules
• Created: 2017-10-24T13:40:12.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T14:19:54.000Z (2 months ago)
• Last Synced: 2024-10-29T16:07:28.801Z (2 months ago)
• Topics: nuxt, nuxt-module, robots-txt, ssr, vuejs
• Language: TypeScript
• Homepage: https://nuxtseo.com/robots
• Size: 3.28 MB
• Stars: 419
• Watchers: 5
• Forks: 33
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
@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](https://nuxtseo.com/learn/controlling-crawlers) which paths they can and cannot access using a [robots.txt](https://nuxtseo.com/learn/controlling-crawlers/robots-txt) file.

- Telling [search engine crawlers](https://developers.google.com/search/docs/crawling-indexing/googlebot) 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](https://nuxtseo.com/learn/controlling-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 tag

- 🔄 Integrates with route rules and runtime hooks

- 🔒 Disables non-production environments from being indexed

- Solves common issues and best practice default config

## Installation

💡 Using Nuxt 2? Please use the [v3.x](https://github.com/nuxt-modules/robots/tree/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](https://nuxtseo.com).

## Documentation

[📖 Read the full documentation](https://nuxtseo.com/robots) for more information.

## Demos

- [Default - StackBlitz](https://stackblitz.com/edit/nuxt-starter-zycxux?file=public%2F_robots.txt)

## Sponsors



  

    

  



## License

Licensed under the [MIT license](https://github.com/nuxt-modules/robots/blob/main/LICENSE.md).

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

[nuxt-href]: https://nuxt.com