README

Laravel package to automatically create a og image that the page generates when it's saved to social media.

Installation
Configuration
Testing
Credits
License

Installation

You can install the package via composer:

composer require paulund/og-image-generator
npm install puppeteer
php artisan vendor:publish --provider="Paulund\OgImageGenerator\OgImageGeneratorServiceProvider"

In the <head></head> tag of your application you need to add the meta og-image tag. Pointing to the route created by the package and passing in a variable of $ogTitle which is the text that will appear on the generated image.

<meta property="og:image" content="{{ route('og-image', ['title' => $ogTitle ]) }}" />

Configuration

There is no configuration required for this package. The package will automatically start generating Open Graph images for social media sharing.

But you can configure the package by publishing the config file, which will allow you to change the following configs.

Image mime type - default is png
Storage disk - default is local
Storage path - default is public/og-images

Testing

vendor/bin/testbench workbench:install
composer check

Credits

License

The MIT License (MIT). Please see License File for more information.

paulund / og-image-generator

Maintainers

Details