Skip to content
Open Graph Image as a Service - generate cards for Twitter, Facebook, Slack, etc
Branch: master
Clone or download
Latest commit d0d6267 Mar 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.fonts
.github Add codeowners file Mar 13, 2019
public Move to zeit org (#67) Mar 4, 2019
src
.gitignore
.nowignore Improve performance Feb 11, 2019
.yarnrc Move to zeit org (#67) Mar 4, 2019
CONTRIBUTING.md Move to zeit org (#67) Mar 4, 2019
Dockerfile Add Dockerfile Feb 5, 2019
LICENSE Create LICENSE Jan 29, 2019
README.md
now.json
package.json
tsconfig.json
yarn.lock

README.md

Open Graph Image as a Service

Serverless service that generates dynamic Open Graph images that you can embed in your <meta> tags.

See the image embedded in the tweet for a real use case.

What is an Open Graph Image?

Have you ever posted a hyperlink to Twitter, Facebook, or Slack and seen an image popup? How did your social network know how to "unfurl" the URL and get an image? The answer is in your <head>.

The Open Graph protocol says you can put a <meta> tag in the <head> of a webpage to define this image.

It looks like the following:

<head>
  <title>Title</title>
  <meta property="og:image" content="http://example.com/logo.jpg" />
</head>

Why use this service?

Read the blog post for more info on the "Why" part.

The short answer is that it would take a long time to painstakingly design an image for every single blog post. And we don't want the exact same image for every blog post because that wouldn't make the article stand out when it was shared to Twitter.

That's where og-image.now.sh comes in. We can simply pass the title of our blog post to our generator service and it will generate the image for us on the fly!

It looks like the following:

<head>
  <title>Hello World</title>
  <meta property="og:image" content="https://og-image.now.sh/Hello%20World.png" />
</head>

Now try changing the text Hello%20World to the title of your choosing and watch the magic happen

Deploy your own

You'll want to fork this repository and deploy your own image generator.

  1. Click the fork button at the top right of GitHub
  2. Clone the repo to your local machine with git clone URL_OF_FORKED_REPO_HERE
  3. Make changes by swapping out images, changing colors, etc (see contributing for more)
  4. Deploy by running now from the CLI (if you don't already have it, run npm install -g now)

Alternatively, you can do a one-click to deploy with the button below.

Deploy to now

Once you have an image generator that sparks joy, you can setup automatic Now + GitHub deployments so that pushing to master is also deploying to production! 🚀

Authors

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.