Skip to content

Document a potential @astrojs/sitemap filenameBase configuration setting #11614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 12, 2025
Merged

Document a potential @astrojs/sitemap filenameBase configuration setting #11614

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eca51cd
Doc @astrojs/sitemap filenameBase config setting
mattyoho May 5, 2025
efa9a0f
Merge branch 'main' into docs-for-filenamebase-sitemap-config-setting
sarah11918 May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/content/docs/en/guides/integrations-guide/sitemap.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,28 @@ export default defineConfig({
});
```

### filenameBase

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

This option may be useful when integrating an Astro site into a domain with preexisting sitemap files.

```js title="astro.config.mjs" ins={8}
import { defineConfig } from 'astro/config';
import sitemap from '@astrojs/sitemap';

export default defineConfig({
site: 'https://stargazers.club',
integrations: [
sitemap({
filenameBase: 'astronomy-sitemap'
}),
],
});
```

The given configuration will generate sitemap files at `https://stargazers.club/astronomy-sitemap-0.xml` and `https://stargazers.club/astronomy-sitemap-index.xml`.

## Examples

* The official Astro website uses Astro Sitemap to generate [its sitemap](https://astro.build/sitemap-index.xml).
Expand Down