Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 2.5 KB

README.md

File metadata and controls

40 lines (27 loc) · 2.5 KB
Raw

Lucid Fox Social Magick

A Joomla 4 and 5 plugin to automatically generate Open Graph images.

Downloads • Issues

What is this

This plugin allows you to automatically generate Open Graph images for your site's pages, superimposing text and graphics over an image or solid color background. Open Graph images are used by social media sites when sharing a URL to any of your site's pages on them.

For example:

Facebook Twitter LinkedIn Slack
Facebook Example Twitter Example LinkedIn Example Slack Example

(Want to check what your site shows now? Check out metatags.io, a site that shows you previews of all social media cards for your link.)

Requirements

This plugin has the following minimum requirements:

  • Joomla 4.3 or later; or Joomla 5.0
  • PHP 7.4, 8.0, 8.1, 8.2, or 8.3
  • The Imagick or GD PHP extension installed and enabled. (If you're not sure how to do this, ask your host.)

Quick start

  • Download and install the plugin ZIP file.
  • Publish the System – Social Magick plugin.
  • Edit the menu item you want to have Open Graph images automatically generated. In its “Open Graph images” tab:
  • Set “Generate Open Graph images” to Yes.
  • Select the Solid template.
  • Save your menu item.
  • Go to metatags.io and paste the URL to the page of your site that corresponds to the menu item you selected. You can now see that it has a preview image.

If you have menu items with core content (Joomla articles) categories and articles which make use of images you can select the Overlay template. You will need to set the “Extra image source” option to “Intro image” or “Full Article image”, depending on which image you want to use.

The templates provided are meant as examples; while you are welcome to use them on your live site, you can also replace the template images with ones that do not have the Social Magick watermark.