Skip to content
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.

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

Support for HTML Content in FAQ Schema #1284

Open
hiroyukinuri opened this issue Aug 8, 2023 · 1 comment
Open

Support for HTML Content in FAQ Schema #1284

hiroyukinuri opened this issue Aug 8, 2023 · 1 comment

Comments

@hiroyukinuri
Copy link

Is your feature request related to a problem? Please describe.
Yes, the problem I am encountering is related to the next-seo package's limitations in supporting HTML in the FAQ page. This limitation makes it difficult to present detailed and formatted content in a way that is easily readable and accessible for users. A lack of HTML support also limits the SEO benefits that can be reaped from an FAQ page as search engines may not accurately interpret and rank the content.

Describe the solution you'd like
I would appreciate a feature update that allows the inclusion of HTML content within the FAQ schema in next-seo. This could involve parsing the HTML content correctly so that it can be appropriately rendered on the page, while also ensuring it adheres to the appropriate schema structure for SEO purposes.

Describe alternatives you've considered
One alternative solution could be manually incorporating the HTML into the page outside of the next-seo framework and then using a different method for SEO optimization. However, this would defeat the purpose of using next-seo and could lead to inconsistencies in SEO practices across the site.

Another alternative could be to strip HTML tags from the content and present it as plain text. However, this sacrifices the usability and presentation of the content, negatively impacting user experience and potentially SEO as well.

Additional context
The schema.org FAQPage schema (link) indicates that the mainEntity (a Question) can contain text that is "The textual content of this CreativeWork." This seems to suggest that HTML, which is essentially text content, should be acceptable.

As per Google's FAQ schema guidelines, HTML content can help enrich the search results snippet, which can boost visibility and clickthrough rates.

@nick-lironi-irvine
Copy link

I also have this use case, where I want to add structured data for existing markdown formatted FAQ entries from a headless CMS

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

No branches or pull requests

2 participants