nuxt-robots-module

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

Table of Contents

• Requirements
• Install
• Getting Started
• Options
• Development
• License

Requirements

• npm or yarn
• NuxtJS
• NodeJS

Install

1$ npm install --save nuxt-robots-module
2// or
3$ yarn add nuxt-robots-module

Getting Started

Add nuxt-robots-module to modules section of nuxt.config.js.

1{
2  modules: [
3    // Simple usage
4    'nuxt-robots-module',
5
6    // With options
7    ['nuxt-robots-module', {
8      /* module options */
9      UserAgent: 'Googlebot',
10      Disallow: '/',
11    }],
12 ]
13}

or even

1{
2  modules: [
3    'nuxt-robots-module',
4  ],
5  robots: {
6    /* module options */
7    UserAgent: '*',
8    Disallow: '/',
9  },
10}

Options

The module option parameter can be an object (like above) or an array of objects.

1{
2  modules: [
3    'nuxt-robots-module',
4  ],
5  robots: [
6    {
7      UserAgent: 'Googlebot',
8      Disallow: '/users',
9    },
10    {
11      UserAgent: 'Bingbot',
12      Disallow: '/admin',
13    },
14  ],
15}

Will generate a /robots.txt

1UserAgent: Googlebot
2Disallow: /users
3UserAgent: Bingbot
4Disallow: /admin

Development

To run the development server, you can either install the dependencies locally by running:

1npm install

or using Docker with docker-compose:

1docker-compose up -d

This will run the a dev example through the 3000 port on localhost. You can then see your generated robots.txt in localhost:3000/robots.txt.

License

Robots.txt generate code from https://github.com/weo-edu/express-robots repository. Project generated with Nuxt module builder.

MIT License