Skip to content

docs: Update sitemaps docs for other wp plugins #251

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
Fran-A-Dev merged 2 commits into from
Jan 30, 2025
Merged

docs: Update sitemaps docs for other wp plugins #251

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6f49b3
Added docs on how to change sitemaps URLS for other WP SEO plugins.
colinmurphy Jan 30, 2025
53278da
Various changes from code review.
colinmurphy Jan 30, 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
20 changes: 20 additions & 0 deletions src/pages/docs/how-to/sitemaps/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,23 @@ export function getServerSideProps(ctx) {
```

Run the dev server again and visit the sitemap URL. You now have WordPress content and Next.js content in your Faust app.

## 4. Changing the sitemap URL for other WP SEO plugins

If you prefer to use a different sitemap instead of the default one provided by WordPress, Faust allows integration with other WordPress SEO plugins like [Rank Math](https://rankmath.com/) or [Yoast SEO](https://yoast.com/wordpress/plugins/seo/).

Simply update the `sitemapIndexPath` argument to point to the plugin's sitemap URL.

Here is an example for the Rank Math plugin:

```js {6} title="pages/sitemap.xml.js"
import { getSitemapProps } from "@faustwp/core";
export default function Sitemap() {}

export function getServerSideProps(ctx) {
return getSitemapProps(ctx, {
sitemapIndexPath: "sitemap_index.xml",
frontendUrl: process.env.FRONTEND_URL,
});
}
```