diff --git a/src/content/docs/en/guides/integrations-guide/sitemap.mdx b/src/content/docs/en/guides/integrations-guide/sitemap.mdx index 930c1c8251933..a66afc08b3fe6 100644 --- a/src/content/docs/en/guides/integrations-guide/sitemap.mdx +++ b/src/content/docs/en/guides/integrations-guide/sitemap.mdx @@ -193,7 +193,12 @@ export default defineConfig({ }); ``` -### filter +### `filter` + +

+ +**Type:** `(page: string) => boolean` +

All pages are included in your sitemap by default. By adding a custom `filter` function, you can filter included pages by URL. @@ -233,7 +238,12 @@ export default defineConfig({ }); ``` -### customPages +### `customPages` + +

+ +**Type:** `string[]` +

An array of externally-generated pages to be included in the generated sitemap file. @@ -253,7 +263,7 @@ export default defineConfig({ }); ``` -### customSitemaps +### `customSitemaps`

@@ -280,7 +290,13 @@ export default defineConfig({ }); ``` -### entryLimit +### `entryLimit` + +

+ +**Type:** `number`
+**Default:** `45000` +

The maximum number entries per sitemap file. The default value is 45000. A sitemap index and multiple sitemaps are created if you have more entries. See this [explanation of splitting up a large sitemap](https://developers.google.com/search/docs/advanced/sitemaps/large-sitemaps). @@ -298,7 +314,13 @@ export default defineConfig({ }); ``` -### changefreq, lastmod, and priority +### `changefreq`, `lastmod`, and `priority` + +

+ +**Type:** `{ changefreq?: ChangeFreq; lastmod?: Date; priority?: number; }` + +

These options correspond to the ``, ``, and `` tags in the [Sitemap XML specification.](https://www.sitemaps.org/protocol.html) @@ -324,7 +346,12 @@ export default defineConfig({ }); ``` -### serialize +### `serialize` + +

+ +**Type:** `(item: SitemapItem) => SitemapItem | Promise | undefined` +

A function called for each sitemap entry just before writing to a disk. This function can be asynchronous. @@ -368,18 +395,19 @@ export default defineConfig({ }); ``` -### i18n +### `i18n` -To localize a sitemap, pass an object to this `i18n` option. +

-This object has two required properties: +**Type:** `{ defaultLocale: string; locales: Record; }` +

-* `defaultLocale`: `String`. Its value must exist as one of `locales` keys. -* `locales`: `Record`, key/value - pairs. The key is used to look for a locale part in a page path. The value is a language attribute, only English alphabet and hyphen allowed. +To [localize a sitemap](https://developers.google.com/search/docs/advanced/crawling/localized-versions#all-method-guidelines), pass an object to this `i18n` option. -[Read more about language attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang). +This object has two required properties: -[Read more about localization](https://developers.google.com/search/docs/advanced/crawling/localized-versions#all-method-guidelines). +* `defaultLocale`: Its value must exist as one of `locales` keys. +* `locales`: key/value - pairs. The key is used to look for a locale part in a page path. The value is a [language attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang), only English alphabet and hyphen allowed. ```js title="astro.config.mjs" ins={8-15} import { defineConfig } from 'astro/config'; @@ -433,7 +461,13 @@ The resulting sitemap looks like this: ... ``` -### xslURL +### `xslURL` + +

+ +**Type:** `string`
+ +

The URL of an XSL stylesheet to style and prettify your sitemap. @@ -453,7 +487,14 @@ export default defineConfig({ }); ``` -### filenameBase +### `filenameBase` + +

+ +**Type:** `string`
+**Default:** `sitemap`
+ +

The name prefix string used when generating the sitemap XML files. The default value is `sitemap`.