feat(sitemap): allow customizing the output name

[Josh-Cena]

Pre-flight checklist

• I have read the Contributing Guidelines on pull requests.
• If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
• If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

See https://docusaurus.canny.io/feature-requests/p/support-multi-instance-sitemaps-plugins

Since sitemap files can be manually uploaded/checked-in, the name is mostly irrelevant.

Test Plan

We don't have tests for this...

Test links

Deploy preview: https://deploy-preview-7469--docusaurus-2.netlify.app/docs/api/plugins/@docusaurus/plugin-sitemap/

Related issues/PRs

[netlify]

✅ [V2]

Name	Link
🔨 Latest commit	5f5b992
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/6290c787db924e00095b6f98
😎 Deploy Preview	https://deploy-preview-7469--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[github-actions]

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 87	🟢 100	🟢 100	🟢 100	🟢 90	Report
/docs/installation	🟠 78	🟢 99	🟢 100	🟢 100	🟢 90	Report

[github-actions]

Size Change: -95 B (0%)

Total Size: 796 kB

Filename	Size	Change
website/build/assets/js/main.********.js	598 kB	-95 B (0%)

ℹ️ View Unchanged

Filename	Size
website/.docusaurus/globalData.json	52.3 kB
website/build/assets/css/styles.********.css	106 kB
website/build/index.html	38.9 kB

_{compressed-size-action}

[slorber]

🤷‍♂️ ok to add this, but I'm not sure to understand the use-case in practice

The docs state that "all Docusaurus content plugins can support multiple plugin instances". This support should extent to other plugins such as plugin-sitemap. For example, we want to weight docs differently in SEO based on their doc ID.

Yes but... all the sitemap plugins would receive the same routes, so unless you plan with the ignorePatterns you end up with the same result 🤷‍♂️

Now, about "weighting" some docIds, I don't know what the op means exactly

https://developers.google.com/search/docs/advanced/sitemaps/build-sitemap#general-guidelines

Google ignores and values.

[dsmmcken]

Yes but... all the sitemap plugins would receive the same routes, so unless you plan with the ignorePatterns you end up with the same result

Thanks for this. I actually have a use case.

I have a section of my site behind http-auth, and would like to exclude those pages from my sitemap that gets submitted to google for indexing. Google continually warns me it can't reach all those pages in the sitemap.

But I also need a full sitemap to pass to the algolia self hosted crawler to still index those pages (that crawls with http-auth).

I intended to publish two sitemaps, one for algolia indexing, one for google, this will make that easier.

[slorber]

Thanks for clarifying, I wouldn't have been able to think of this use-case 🤪