https://github.com/loveduckie/silverstripe-json-ld-structured-data

A Silverstripe module for conveniently injecting JSON-LD structured data SiteTree pages and DataObjects rendered by controllers.
https://github.com/loveduckie/silverstripe-json-ld-structured-data

composer json json-ld php silverstripe silverstripe-4 silverstripe-5 silverstripe-module silverstripe4 silverstripe5

Last synced: about 1 month ago
JSON representation

A Silverstripe module for conveniently injecting JSON-LD structured data SiteTree pages and DataObjects rendered by controllers.

• Host: GitHub
• URL: https://github.com/loveduckie/silverstripe-json-ld-structured-data
• Owner: LoveDuckie
• License: bsd-3-clause
• Created: 2022-01-30T17:50:50.000Z (almost 3 years ago)
• Default Branch: 4
• Last Pushed: 2024-06-21T09:52:07.000Z (6 months ago)
• Last Synced: 2024-11-07T17:09:57.166Z (about 2 months ago)
• Topics: composer, json, json-ld, php, silverstripe, silverstripe-4, silverstripe-5, silverstripe-module, silverstripe4, silverstripe5
• Language: PHP
• Homepage: https://lucshelton.com/blog/silverstripe-and-json-ld-structured-data
• Size: 96.7 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# silverstripe-json-ld-structured-data

A SilverStripe module for conveniently injecting [JSON-LD](https://json-ld.org/) metadata into the header of each rendered page in SilverStripe.

For more information on "[JSON-LD structured data](https://developers.google.com/search/docs/advanced/structured-data/intro-structured-data)", please refer to the Google Developer pages.

[https://lucshelton.com/projects/personal/silverstripe-json-ld-structed-data-module/](https://lucshelton.com/projects/personal/silverstripe-json-ld-structed-data-module/)

## Installation

```shell

composer require loveduckie/silverstripe-json-ld-structured-data 4.x-dev

```

## Requirements

* SilverStripe ^4.0

* [Yarn](https://yarnpkg.com/lang/en/), [NodeJS](https://nodejs.org/en/) (6.x) and [npm](https://npmjs.com) (for building

  frontend assets)

## Maintainers

* Luc Shelton 

## Documentation

* [Documentation readme](docs/en/readme.md)

## Configuration

The extensions in this module will automatically inject itself into the SiteTree type. Refer to the adopted configuration below.

```yaml

---

Name: silverstripe-json-ld-structured-data

---

SilverStripe\CMS\Model\SiteTree:

  extensions:

    - LoveDuckie\SilverStripe\Extensions\JsonLDStructuredDataExtension

```

## License

See [License](license.md)

## Bugtracker

If the issue does look like a new bug:

* Create a new issue

* Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots

 and screencasts can help here.

* Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version,

 Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.

## Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.