dleatherman/api-opengraph-image

Open Graph Image API

A runtime service to return optimized Open Graph images from a URL. Works with:

1. <meta name="og:image:secure_url">
2. <meta name="og:image">
3. <meta property="og:image">
4. <meta name="twitter:image">

Usage

URLs have the formats:

/:url/
/:url/:size/
/:url/:size/:format/

• url must be URI encoded.
• size (optional) can be small (375×_), medium (650×_), or auto (keep original width)
• format must by an output image format supported by Eleventy Image

Deploy your own

Demos

Advanced: Manual Cache Busting

If the images aren’t updating at a high enough frequency you can pass in your own cache busting key using an underscore prefix _ after your URL.

This can be any arbitrary string tied to your unique build, here’s an example that uses today’s date.

/:url/_20210802/
/:url/:size/_20210802/
/:url/:size/:format/_20210802/