Skip to content

Conversation

@colinmurphy
Copy link
Member

Included an example pf how to integrate Rank Math with Faust.

For reference see the original PR here in Faust - wpengine/faustjs#1936

@colinmurphy colinmurphy marked this pull request as ready for review January 30, 2025 15:22
@headless-platform-by-wp-engine

Check out the recent updates to your Headless Platform preview environment:

App Environment URL Build
faustjs.org preview-env-docs-update-sitemaps-docs-for-other-wp-plugins https://hf…wered.com ✅ (logs)

Learn more about preview environments in our documentation.


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 WordPress SEO plugins
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change this section header to fit the page better with the link icon to this :

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


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

If you wanted to use a different sitemap than the one that comes out of the box with WordPress this is possible with Faust for other WordPress SEO plugins like Rank Math or Yoast SEO.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider restructuring the paragraph to this and linking the plugins to their respective pages:

"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 or Yoast SEO.


If you wanted to use a different sitemap than the one that comes out of the box with WordPress this is possible with Faust for other WordPress SEO plugins like Rank Math or Yoast SEO.

You just need to update the argument for `sitemapIndexPath` to point to the plugins sitemap URL.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider changing this sentence to this:

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


You just need to update the argument for `sitemapIndexPath` to point to the plugins sitemap URL.

e.g. for Rank Math:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change this to the sentence below to this:

"Here is an example for the Rank Math plugin:"


e.g. for Rank Math:

```js title="pages/sitemap.xml.js"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Highlight the arg that you want the reader to focus on:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@colinmurphy I don't know why GH is not showing the line of MDX but this is what I am suggesting:

js {6} title="pages/sitemap.xml.js"

Copy link
Member Author

@colinmurphy colinmurphy Jan 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Fran-A-Dev

That i s a really good tip. I never knew you could do that so thank you 😄

@colinmurphy
Copy link
Member Author

Thanks @Fran-A-Dev for the review 😄

I will look at updating the PR now. I really appreciate the good feedback 👍

@headless-platform-by-wp-engine

Check out the recent updates to your Headless Platform preview environment:

App Environment URL Build
faustjs.org preview-env-docs-update-sitemaps-docs-for-other-wp-plugins https://hf…wered.com ✅ (logs)

Learn more about preview environments in our documentation.

Copy link
Contributor

@Fran-A-Dev Fran-A-Dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Fran-A-Dev Fran-A-Dev merged commit bc590a0 into toolkit Jan 30, 2025
4 checks passed
@Fran-A-Dev Fran-A-Dev deleted the docs-update-sitemaps-docs-for-other-wp-plugins branch January 30, 2025 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants