search

AllanPooley / gatsby-theme-faqs-prismic

A pretty FAQ page for Gatsby projects, out of the box 🌻❓🙋
36 stars 8 forks source link

Google Structured Data Support #16

Open ben-wright opened 4 years ago

ben-wright commented 4 years ago

Looking at #15 I have seen there has been added support for Google Structured data.

I tried testing this on the demo: https://gatsby-theme-faqs.netlify.com/

However no FAQ related structured data was returned.

image

Is this because the demo hasn't been updated?

Many thanks for the work on this plugin, works perfect with Gatsby❤️🚀

AllanPooley commented 4 years ago

Hey @ben-wright, thanks for checking this out and creating this issue.

That's correct, I haven't updated the demo yet! I'll do that now.

In the mean time, here's a project I'm working on with the updated version: https://withkua.netlify.com/frequently-asked-questions/

image

image

I think this looks right?

AllanPooley commented 4 years ago

Hey @ben-wright I've added this to the demo:

image

Check it out: https://gatsby-theme-faqs.netlify.com/faq/

Feel free to reopen if you spot any issues (not an expert on structured data)

ben-wright commented 4 years ago

Thanks for a quick response on this @AllanPooley . I'm not sure how lenient Google's structured data is, however I think the '@type' key needs to be equal to 'FAQPage' and then there should be a list of question and answers under the 'mainEntity' key.

As described here https://developers.google.com/search/docs/data-types/faqpage

Here is another example of an FAQ page, it bundles them up into a 'ItemList' type rather than an 'FAQPage' https://search.google.com/structured-data/testing-tool/u/0/#url=https%3A%2F%2Fyoast.com%2Fyoast-diversity-fund%2Fapply%2F (However I think the first example is more suitable)

Hope this helped and let me know if you would like me to pick this one up :)