README

This plugin is for easily generating JSON Schema structured data.

Install

Download

Download and copy this repository to /site/plugins/kirby3-schema.

Composer

composer require hashandsalt/kirby3-schema

Commercial Usage

This plugin is free but if you use it in a commercial project please consider to

• make a donation 🍻 or
• buy a Kirby license using this affiliate link

Usage

It's a wrapper around spatie/schema-org that turns it into a site method, used like this:

<?= $site->schema('LocalBusiness')
  ->name('Hash&Salt')
  ->email('email@example.com')
  ->contactPoint($page->schema('contactPoint')
  ->areaServed('Worldwide')
  ) ?>

You can use the if() method to prevent missing data from breaking the chain.

<?= $site->schema('LocalBusiness')
->name('Hash&Salt')

->if($page->email()->exists(), function ($site) {
  $site->schema('email')->email('email@example.com');
})

->contactPoint($page->schema('contactPoint')
->areaServed('Worldwide')
) ?>

It supports anything thats in the RDFa spec for structured data which is about 600 data points. Refer to schema.org site for details on each bit. Go nuts :)