nuxt-robots-module
A NuxtJS module thats inject a middleware to generate a robots.txt file
Table of Contents
Requirements
- npm or yarn
- NuxtJS
- NodeJS
Install
$ npm install --save nuxt-robots-module// or$ yarn add nuxt-robots-module
Getting Started
Add nuxt-robots-module
to modules
section of nuxt.config.js
.
modules: // Simple usage 'nuxt-robots-module' // With options 'nuxt-robots-module' /* module options */ UserAgent: 'Googlebot' Disallow: '/'
or even
modules: 'nuxt-robots-module' robots: /* module options */ UserAgent: '*' Disallow: '/'
Options
The module option parameter can be an object
(like above) or an array of objects
.
modules: 'nuxt-robots-module' robots: UserAgent: 'Googlebot' Disallow: '/users' UserAgent: 'Bingbot' Disallow: '/admin'
Will generate a /robots.txt
UserAgent: GooglebotDisallow: /usersUserAgent: BingbotDisallow: /admin
Development
To run the development server, you can either install the dependencies locally by running:
npm install
or using Docker
with docker-compose
:
docker-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.