mirror of
https://github.com/hanzoai/next.js.git
synced 2026-09-24 17:00:51 +00:00
d08e891ea6
Addition to docs (robots.mdx) - Customize user-agent rules For issue #59178 Docs: Guidance on allowing multiple user agent rules with varying allow/disallow. <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> --------- Co-authored-by: Delba de Oliveira <[email protected]> Co-authored-by: Sam Ko <[email protected]> Co-authored-by: Delba de Oliveira <[email protected]>
147 lines
2.8 KiB
Plaintext
147 lines
2.8 KiB
Plaintext
---
|
|
title: robots.txt
|
|
description: API Reference for robots.txt file.
|
|
---
|
|
|
|
Add or generate a `robots.txt` file that matches the [Robots Exclusion Standard](https://en.wikipedia.org/wiki/Robots.txt#Standard) in the **root** of `app` directory to tell search engine crawlers which URLs they can access on your site.
|
|
|
|
## Static `robots.txt`
|
|
|
|
```txt filename="app/robots.txt"
|
|
User-Agent: *
|
|
Allow: /
|
|
Disallow: /private/
|
|
|
|
Sitemap: https://acme.com/sitemap.xml
|
|
```
|
|
|
|
## Generate a Robots file
|
|
|
|
Add a `robots.js` or `robots.ts` file that returns a [`Robots` object](#robots-object).
|
|
|
|
```ts filename="app/robots.ts" switcher
|
|
import { MetadataRoute } from 'next'
|
|
|
|
export default function robots(): MetadataRoute.Robots {
|
|
return {
|
|
rules: {
|
|
userAgent: '*',
|
|
allow: '/',
|
|
disallow: '/private/',
|
|
},
|
|
sitemap: 'https://acme.com/sitemap.xml',
|
|
}
|
|
}
|
|
```
|
|
|
|
```js filename="app/robots.js" switcher
|
|
export default function robots() {
|
|
return {
|
|
rules: {
|
|
userAgent: '*',
|
|
allow: '/',
|
|
disallow: '/private/',
|
|
},
|
|
sitemap: 'https://acme.com/sitemap.xml',
|
|
}
|
|
}
|
|
```
|
|
|
|
Output:
|
|
|
|
```txt
|
|
User-Agent: *
|
|
Allow: /
|
|
Disallow: /private/
|
|
|
|
Sitemap: https://acme.com/sitemap.xml
|
|
```
|
|
|
|
### Customizing specific user agents
|
|
|
|
You can customise how individual search engine bots crawl your site by passing an array of user agents to the `rules` property. For example:
|
|
|
|
```ts filename="app/robots.ts" switcher
|
|
import type { MetadataRoute } from 'next'
|
|
|
|
export default function robots(): MetadataRoute.Robots {
|
|
return {
|
|
rules: [
|
|
{
|
|
userAgent: 'Googlebot',
|
|
allow: ['/'],
|
|
disallow: '/private/',
|
|
},
|
|
{
|
|
userAgent: ['Applebot', 'Bingbot'],
|
|
disallow: ['/'],
|
|
},
|
|
],
|
|
sitemap: 'https://acme.com/sitemap.xml',
|
|
}
|
|
}
|
|
```
|
|
|
|
```js filename="app/robots.js" switcher
|
|
export default function robots() {
|
|
return {
|
|
rules: [
|
|
{
|
|
userAgent: 'Googlebot',
|
|
allow: ['/'],
|
|
disallow: ['/private/'],
|
|
},
|
|
{
|
|
userAgent: ['Applebot', 'Bingbot'],
|
|
disallow: ['/'],
|
|
},
|
|
],
|
|
sitemap: 'https://acme.com/sitemap.xml',
|
|
}
|
|
}
|
|
```
|
|
|
|
Output:
|
|
|
|
```txt
|
|
User-Agent: Googlebot
|
|
Allow: /
|
|
Disallow: /private/
|
|
|
|
User-Agent: Applebot
|
|
Disallow: /
|
|
|
|
User-Agent: Bingbot
|
|
Disallow: /
|
|
|
|
Sitemap: https://acme.com/sitemap.xml
|
|
```
|
|
|
|
### Robots object
|
|
|
|
```tsx
|
|
type Robots = {
|
|
rules:
|
|
| {
|
|
userAgent?: string | string[]
|
|
allow?: string | string[]
|
|
disallow?: string | string[]
|
|
crawlDelay?: number
|
|
}
|
|
| Array<{
|
|
userAgent: string | string[]
|
|
allow?: string | string[]
|
|
disallow?: string | string[]
|
|
crawlDelay?: number
|
|
}>
|
|
sitemap?: string | string[]
|
|
host?: string
|
|
}
|
|
```
|
|
|
|
## Version History
|
|
|
|
| Version | Changes |
|
|
| --------- | -------------------- |
|
|
| `v13.3.0` | `robots` introduced. |
|