This commit is contained in:
2026-07-31 23:21:51 +02:00
parent f6b4b36df8
commit f14f2cfd98
294 changed files with 5880 additions and 0 deletions
+36
View File
@@ -0,0 +1,36 @@
type BuildRobotsArgs = {
/** Absolute origin, e.g. 'https://example.com'. */
baseUrl: string;
/** Paths to disallow. Defaults to Payload's admin and API. */
disallow?: string[];
/** Whether to advertise the sitemap. Defaults to true. */
sitemap?: boolean;
};
/**
* Shape for Next's `app/robots.ts`.
*/
export type RobotsRules = {
host?: string;
rules: {
allow?: string;
disallow?: string[];
userAgent: string;
};
sitemap?: string;
};
/**
* Builds robots rules that allow crawling everything except the admin panel and
* API, and point crawlers at the sitemap.
*
* ```ts
* // app/robots.ts
* export default function robots() {
* return buildRobots({ baseUrl: process.env.NEXT_PUBLIC_SERVER_URL! })
* }
* ```
*
* The admin and API are disallowed by default — no reason for them in the index,
* and it keeps crawl budget on real content.
*/
export declare function buildRobots({ baseUrl, disallow, sitemap, }: BuildRobotsArgs): RobotsRules;
export {};