Need help with robots-module?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

nuxt-community
205 Stars 7 Forks MIT License 105 Commits 4 Opened issues

Description

NuxtJS module for robots.txt

Services available

!
?

Need anything else?

Contributors list

@nuxtjs/robots

npm version npm downloads Github Actions CI Codecov License

A Nuxt.js module thats inject a middleware to generate a robots.txt file

📖 Release Notes

Setup

  1. Add
    @nuxtjs/robots
    dependency to your project
yarn add @nuxtjs/robots # or npm install @nuxtjs/robots
  1. Add
    @nuxtjs/robots
    to the
    modules
    section of
    nuxt.config.js
export default {
  modules: [
    // Simple usage
    '@nuxtjs/robots',

// With options
['@nuxtjs/robots', { /* module options */ }]

] }

Using top level options

export default {
  modules: [
    '@nuxtjs/robots'
  ],
  robots: {
    /* module options */
  }
}

Options

The module option parameter can be:

Object

export default {
  robots: {
    UserAgent: '*',
    Disallow: '/'
  }
}

Array

export default {
  robots: [
    {
      UserAgent: 'Googlebot',
      Disallow: () => '/users' // accepts function
    }
  ]
}

Function

export default {
  robots: () => {
    return {
      UserAgent: '*',
      Disallow: '/'
    }
  }
}

Will generate a /robots.txt

User-agent: Googlebot
Disallow: /users
User-agent: Bingbot
Disallow: /admin

The keys and values available:

  • UserAgent =
    User-agent
  • CrawlDelay =
    Crawl-delay
  • Disallow =
    Disallow
  • Allow =
    Allow
  • Host =
    Host
  • Sitemap =
    Sitemap
  • CleanParam =
    Clean-param

Note: Don't worry keys are parsed with case insensitive and special characters.

License

MIT License

Copyright (c) - Nuxt Community

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.