Introduce configurable "sitemap index path" for enhanced plugin compatibility

[josephfusco]

Description

This PR introduces a new feature allowing the configuration of a custom sitemap index path via the sitemapIndexPath option in the getSitemapProps function. This is particularly useful for ensuring compatibility with WordPress plugins like RankMath that modify the default sitemap path.

To configure a custom sitemap index path, update your getServerSideProps function in your Next.js page as follows:

import { getSitemapProps } from '@faustwp/core';

export default function Sitemap() {}

export function getServerSideProps(ctx) {
  return getSitemapProps(ctx, {
    sitemapIndexPath: '/sitemap_index.xml', // Specify the custom sitemap index path
    frontendUrl: process.env.NEXT_PUBLIC_SITE_URL,
  });
}

This is particularly useful when using WordPress plugins like RankMath that change the default sitemap path from /wp-sitemap.xml to another path, such as /sitemap_index.xml.

Related Issue(s):

• Sitemaps.xml breaks upon updates made in RankMath #1885

Testing

1. Enable RankMath and ensure it changes the sitemap index path to /sitemap_index.xml.
2. Update getServerSideProps with sitemapIndexPath: /sitemap_index.xml.
3. Deploy the application.
4. Visit /sitemap.xml and verify the sitemap loads correctly.
5. Confirm all expected URLs are present and no 404 errors occur.

[changeset-bot]

🦋 Changeset detected

Latest commit: f2ce48a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@faustwp/core	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

📦 Next.js Bundle Analysis for @faustwp/getting-started-example

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

[theodesp]

LGTM!