2.0.1 • Published 3 years ago
nuxt-robots v2.0.1
nuxt-robots
Setup
- Add
nuxt-robots
dependency to your project
yarn add nuxt-robots # or npm install nuxt-robots
- Add
nuxt-robots
to themodules
section ofnuxt.config.js
export default {
modules: [
// Simple usage
'nuxt-robots',
// With options
['nuxt-robots', {
/* module options */
cacheTime: 1000 * 60 * 10,
robots: () => {
return []
}
}]
]
}
Using top level options
export default {
modules: [
'nuxt-robots'
],
robots: {
/* module options */
cacheTime: 1000 * 60 * 10,
robots: () => {
return []
}
}
}
cache time
default 1000 60 10 s
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.
The original link @nuxtjs/robots