https://github.com/vdlp/oc-schemaorg-plugin

Provides the rendering of structured data on your October CMS powered website.
https://github.com/vdlp/oc-schemaorg-plugin

cms laravel october-cms october-plugin octobercms php schemaorg search seo

Last synced: about 2 hours ago
JSON representation

Provides the rendering of structured data on your October CMS powered website.

• Host: GitHub
• URL: https://github.com/vdlp/oc-schemaorg-plugin
• Owner: vdlp
• License: gpl-2.0
• Created: 2019-12-02T13:32:11.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-14T13:59:12.000Z (8 months ago)
• Last Synced: 2024-03-14T15:19:39.811Z (8 months ago)
• Topics: cms, laravel, october-cms, october-plugin, octobercms, php, schemaorg, search, seo
• Language: PHP
• Homepage:
• Size: 29.3 KB
• Stars: 4
• Watchers: 9
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vdlp.SchemaOrg

Provides the rendering of structured data on your October CMS powered website.

## What is structured data?

Structured data is code in a specific format, written in such a way that search engines understand it. Search engines read the code and use it to display search results in a specific and much richer way. You can easily put this piece of code on your website.

There are all kinds of structured data. Structured data is always a code format. There’s structured data for books, for reviews, for movies, and for products in your online store, for instance. In all cases, structured data adds more details to your snippet in the search results.

Browse [Google’s Search Gallery](https://developers.google.com/search/docs/advanced/structured-data/search-gallery) to see which rich results are powered by structured data.

Source: [yoast.com](https://yoast.com/what-is-structured-data/)

## Requirements

- PHP 8.0 or higher

- October CMS 3.0 or higher

## Installation

`composer require vdlp/oc-schemaorg-plugin`

## Usage

To render structured data from a component you can listen to the `Vdlp\SchemaOrg\Classes\Events\FetchStructuredData` event.

Example:

```

/** @var \Illuminate\Contracts\Events\Dispatcher $eventDispatcher */

$eventDispatcher = resolve(\Illuminate\Contracts\Events\Dispatcher::class);

$eventDispatcher->listen(\Vdlp\SchemaOrg\Classes\Events\FetchStructuredData::class, static function () {

    return \Spatie\SchemaOrg\Schema::localBusiness()

        ->name('VDLP')

        ->email('[email protected]')

        ->contactPoint(\Spatie\SchemaOrg\Schema::contactPoint()->areaServed('Worldwide'));

});

```

Add the `vdlpStructuredData` component to your page or layout to render the structured data.

## Issues

If you have issues using this plugin. Please create an issue on GitHub or contact us at [[email protected]]().