lightspeedwp / lsx

LSX is an flexible, light-weight, minimalistic and responsive theme designed to empower makers to build beautifully rich websites with WordPress block editor. The theme displays perfectly on all desktop & mobile devices.
https://lsdev.biz/lsx/
GNU General Public License v3.0
34 stars 3 forks source link

Add styling support for the Yoast SEO plugin HowTo block #363

Closed ashleyshaw closed 4 years ago

ashleyshaw commented 4 years ago

Is your enhancement related to a problem? Please describe.

LSX already supports Yoast SEO breadcrumbs (which includes structured data). We need to continue to add support to LSX for various new Yoast SEO features and blocks.

The Yoast HowTo block allows adding a set of questions and corresponding answers to a post or page. This is based on Schema.org's 'Question' format, so search engines actually understand that your post or page addresses a question, as posed by a user. And in the future, Google will show your post or page as such in its search results.

The Yoast SEO block does not look very good when used with the LSX theme.

Describe the solution you'd like

Add styling support for the Yoast FAQ block to the LSX Theme using this developer documentation.

Consider using existing Bootstrap Collapse JavaScript component and LSX styling classes.

Design: FAQ with clear visual separation

FAQ-design-suggestion

Design: FAQ with collapsible headers

FAQ-collapsableheader

Describe alternatives you've considered

We could use the LSX Blocks Accordion block, but that does not include the structured data support that Yoast SEO does. Considering we install Yoast SEO on all our sites we might as well use their blocks.

Additional context

The FAQ Block will only be used on FAQ pages, read more how we can use Yoast SEO to build a structured data-powered FAQ page using Yoast SEO

jacquesvdhorst commented 4 years ago

LGTM!