GreenHat SBS products, reviews and appendices

Introduction

Products and reviews have two functions in GreenHat SBS. First of all, they are used to generate schema.org structured data, which will help your site's SEO and please Google. Secondly, they adorn your posts with things like star ratings and an appendix that summarises your product and review.

None of this is essential to your site and of course you don't have to use it.

Basic structure

Products are defined via a post's front-matter underneath the products key and each product must have a unique tag as follows:

products:
   my-product-1:
      [definitions here]
   my-product-2:
      [definitions here]

The tags in the above code are my-product-1 and my-product-2.

Reviews are related to products. They go under the reviews key in the front-matter and they must use the same tag as the product being reviewed. So to review the two products specified above, you'd have something like this:

reviews:
   my-product-1:
      [definitions here]
   my-product-2:
      [definitions here]

Reviews

Specifying reviews is quite simple. Give them the same tag as the product and there are only two essential fields. See the following example:

reviews:
   my-product-1:
      rating: 3.5
      description: An excellent product with much to recommend it.

The rating is the number of stars from 0 to 5 in half star increments.

The description is a brief overview of the review. Your post content will contain the full review and the description here is a summary of that review (100-200 characters).