Package Exports

@nuxtjs/robots

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nuxtjs/robots) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@nuxtjs/robots

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

📖 Release Notes

Setup

Add @nuxtjs/robots dependency to your project

yarn add @nuxtjs/robots # or npm install @nuxtjs/robots

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

Thanks William DA SILVA for making this module