[](https://www.npmjs.com/package/astro-opengraph-images)
Generate Open Graph images for your Astro site.
This project is actively maintained. If you have a feature request or need help, please [create an issue](https://github.com/shepherdjerred/monorepo/issues/new).
## What is Open Graph?
[Open Graph](https://ogp.me/) is a protocol created by Facebook. It allows pages on your site to be richly embedded into other sites and applications.
You've probably seen this in action when posting a link on Facebook, Twitter, Slack, iMessage, or Discord. Links posted in supported applications will display the Open Graph metadata which often includes an image. This library will generate those images for you.
## Features
> [!WARNING]
> This integration has only been tested with statically rendered sites. It is untested with server-side rendering.
- Written in TypeScript
- Generate Open Graph images for every page on your site.
- Use a preset renderer to get started quickly.
- Images are fully customizable using [Satori](https://github.com/vercel/satori).
- Use React/JSX + Tailwind syntax or vanilla JavaScript to define your own custom images.
- Supports both static pages and Astro content collections.
- Pages can be written in Markdown, MDX, HTML, or any other format.
## Quick Start
To better illustrate these steps, I've created a [video](https://www.loom.com/share/a66a65be8a4e48ec8612b78489db590d?sid=3e9f7cd6-68ec-49da-b942-75eb4608cb5e) following them to help others follow along.
1. Add this integration to your Astro config:
- Option 1: use the `astro` command:
```bash
npx astro add astro-opengraph-images
```
- Option 2: install the package and add the integration to your Astro config:
```bash
npm i astro-opengraph-images
```
```diff
+import opengraphImages from "astro-opengraph-images";
export default defineConfig({
integrations: [
+ opengraphImages()
],
});
```
1. Install React. React is used by the presets, and can be used to easily author custom images. Note that React is only used for generating the images and will not be shipped to clients.
```bash
npm i -D react
```
1. Install the fonts you want to use. Fonts must be explicitly declared to be used for images. System fonts are _not_ available. For this quick start guide, we'll install the [Roboto](https://fontsource.org/fonts/roboto) font:
```bash
npm i @fontsource/roboto
```
You can find more fonts on [Fontsource](https://fontsource.org/), or you can use any font file that you have. See [Satori's font documentation](https://github.com/vercel/satori?tab=readme-ov-file#fonts) for more information.
1. Configure the integration in your Astro config:
```diff
-import opengraphImages from "astro-opengraph-images";
+import opengraphImages, { presets } from "astro-opengraph-images";
+import * as fs from "fs"; // The fs module is required to load fonts
export default defineConfig({
integrations: [
- opengraphImages()
+ opengraphImages({
+ options: {
+ fonts: [
+ {
+ name: "Roboto",
+ weight: 400,
+ style: "normal",
+ data: fs.readFileSync("node_modules/@fontsource/roboto/files/roboto-latin-400-normal.woff"),
+ },
+ ],
+ },
+ render: presets.blackAndWhite,
+ }),
],
});
```
1. Set the [`site`](https://docs.astro.build/en/reference/configuration-reference/#site) property in your Astro config:
Open Graph requires URLs to be absolute, including the domain your site is hosted at. This integration uses the site defined in your Astro config to create the correct URLs for Open Graph which is `site` must be defined.
```diff
export default defineConfig({
+ site: "https://.com",
integrations: [
opengraphImages({
options: {
fonts: [
{
name: "Roboto",
weight: 400,
style: "normal",
data: fs.readFileSync("node_modules/@fontsource/roboto/files/roboto-latin-400-normal.woff"),
},
],
},
render: presets.blackAndWhite,
}),
],
});
```
1. Update your main Astro layout with the appropriate `meta` tags. The [Open Graph site](https://ogp.me/) has more information possible tags.
The following `meta` tags must be defined:
- `og:title`
- This field may be used when generating images.
- `og:type`
- See the [Open Graph documentation](https://ogp.me/#types) for valid values.
- `og:image`
- Set this to the return value of `getImagePath` (example shown below).
- If the value of `og:image` does not match what this integration expects then your site will fail to build. This will ensure your site is correctly configured to display Open Graph images.
- `og:description`
- Optional. This field may be used when generating images.
Your site will fail to build if the tags above are not set.
- Option 1: Use the [`astro-seo`](https://github.com/jonasmerlin/astro-seo) package:
Install the `astro-seo` package:
```bash
npm i astro-seo
```
Update your Astro layout to use the `SEO` component:
```diff
---
+import { SEO } from "astro-seo";
+import { getImagePath } from "astro-opengraph-images";
interface Props {
title: string;
}
const { title } = Astro.props;
+const { url, site } = Astro;
+const openGraphImageUrl = getImagePath({ url, site });
---
{title}
+
```
- Option 2: Manually add the `meta` tags to your Astro layout.
1. Build your site. You should see a `.png` file next to each `.html` page in your `dist` folder. Double-check that the `og:image` proprety in your `.html` file matches the path to the `.png` file.
1. Deploy your site. You can verify that your images are correct by:
- Sending a link to your site in an application that supports Open Graph like iMessage, Slack, Discord, etc.
- Visit [opengraph.xyz](http://opengraph.xyz/) and test your site.
## Examples
There are example sites using this integration under [`examples/`](https://github.com/shepherdjerred/monorepo/tree/main/packages/astro-opengraph-images/examples).
### Sites Using This
If you're using this project, [open a PR](https://github.com/shepherdjerred/monorepo/compare) to add your site to this list.
- [sjer.red](https://sjer.red) ([source](https://github.com/shepherdjerred/monorepo))
## Filtering Pages
By default, this integration generates an Open Graph image for every page in your build output. Pass an optional `pathFilter` callback to skip pages before their output files are read — for example, the 404 page, utility routes, or sections where images don't apply.
The `pathFilter` callback receives the page pathname. Return `true` to continue processing the page and `false` to skip it. The callback may be synchronous or return a `Promise`.
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
options: { fonts: [/* ... */] },
render: presets.blackAndWhite,
+ // Only generate images for blog posts
+ pathFilter: ({ pathname }) => pathname.startsWith("/blog/"),
}),
],
});
```
More examples:
```typescript
// Exclude utility pages before their HTML is read
pathFilter: ({ pathname }) => !["/404/", "/"].includes(pathname);
// Filter on DOM content after Open Graph metadata has been extracted
filter: async ({ document, type }) =>
type === "article" && document.querySelector("article") !== null;
```
Use `pathFilter` when excluded pages may not have the required Open Graph metadata. The metadata-aware `filter` runs only after the output HTML is read, parsed, and strictly extracted, so it is never called for a page missing any of these required tags: `og:title`, `og:url`, `og:type`, or `og:image`. A missing required tag fails the build before `filter` can return `false`. When `verbose: true` is set on `options`, skipped pages are logged.
## Custom Renderers
You can create your own custom images with a render function. Take a look at how [a preset](https://github.com/shepherdjerred/monorepo/blob/main/packages/astro-opengraph-images/src/presets/blackAndWhite.tsx) works.
Renderers have access to the page's DOM using [jsdom](https://github.com/jsdom/jsdom). You can use this to render your Open Graph image using any of the content from the associated HTML page. An example of this is shown in the [custom property preset](https://github.com/shepherdjerred/monorepo/blob/main/packages/astro-opengraph-images/src/presets/customProperty.tsx) which shows a preview of the page's body text in the Open Graph image.
This library uses [Satori](https://github.com/vercel/satori) to convert React components to SVG. The SVG is then converted to a PNG using [resvg-js](https://github.com/yisibl/resvg-js).
> [!TIP]
> Satori supports [a subset of CSS](https://github.com/vercel/satori?tab=readme-ov-file#css). Be sure to familiarize yourself with its limitations.
>
> You can use the [Satori playground](https://og-playground.vercel.app/) to work on your images.
>
> You can use Tailwind syntax with [tw-to-css](https://github.com/vinicoder/tw-to-css). An example is the [Tailwind preset](https://github.com/shepherdjerred/monorepo/blob/main/packages/astro-opengraph-images/src/presets/tailwind.tsx). You'll need to install this package yourself.
### Loading Local Images
You may receive an error when setting the source attribute on an `img` tag, claiming you need an absolute URL. When using a custom renderer, you can load local images to use in your final image using the following syntax in your `.tsx` file:
```javascript
const filePath = path.join(process.cwd(), "src", "assets", "my-image.png");
const imageBase64 = `data:image/png;base64,${fs.readFileSync(filePath).toString("base64")}`;
```
The code above will load the image at `src/assets/my-image.png` and convert it to a base64 string which can be passed to an image tag's `src` attribute. Be sure to update the `data:image/png;base64,` part of the string to match the image's type and that the image's file ath is correct.
```jsx
```
Here's a complete example of a custom renderer with a locally loaded image:
```tsx
import type { RenderFunctionInput } from "astro-opengraph-images";
const { twj } = await import("tw-to-css");
// Remember to import these modules
import path from "path";
import * as fs from "node:fs";
const filePath = path.join(
process.cwd(),
"src",
"assets",
"my-image.png",
);
const imageBase64 = `data:image/png;base64,${fs.readFileSync(filePath).toString("base64")}`;
// from https://fullstackheroes.com/resources/vercel-og-templates/simple/
export async function simpleBlog({ title, description }: RenderFunctionInput): Promise {
return Promise.resolve(
{title}
{description}
,
);
}
```
## Emoji Support
By default, emojis in your page titles or descriptions will not render correctly because system fonts are disabled and standard fonts don't include emoji glyphs.
To enable emoji support, use the `loadAdditionalAsset` option to fetch emoji images from a CDN like [Twemoji](https://github.com/jdecked/twemoji):
```typescript
import opengraphImages, { presets } from "astro-opengraph-images";
import * as fs from "fs";
export default defineConfig({
site: "https://example.com",
integrations: [
opengraphImages({
options: {
fonts: [
{
name: "Roboto",
weight: 400,
style: "normal",
data: fs.readFileSync(
"node_modules/@fontsource/roboto/files/roboto-latin-400-normal.woff",
),
},
],
loadAdditionalAsset: async (languageCode, segment) => {
if (languageCode === "emoji") {
// Fetch emoji SVG from Twemoji CDN
return `https://cdn.jsdelivr.net/gh/jdecked/twemoji@latest/assets/svg/${segment.codePointAt(0)?.toString(16)}.svg`;
}
// Return empty array for other assets (e.g., fallback fonts)
return [];
},
},
render: presets.blackAndWhite,
}),
],
});
```
The `loadAdditionalAsset` callback is called by [Satori](https://github.com/vercel/satori) whenever it encounters a character that isn't covered by the provided fonts. For emojis, returning an SVG URL will render the emoji correctly in your Open Graph images.
## Presets
Presets are located in [`src/presets/`](https://github.com/shepherdjerred/monorepo/tree/main/packages/astro-opengraph-images/src/presets). [Open a pull request](https://github.com/shepherdjerred/monorepo/compare) to contribute a preset you've created.
Note: some presets use the [`tw-to-css`](https://github.com/vinicoder/tw-to-css) library. You'll need to install this dependency separately when using one of these presets. You'll see an error if the library is not already installed.
```bash
npm i tw-to-css
```
### `backgroundImage`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.backgroundImage,
}),
],
});
```
### `blackAndWhite`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.blackAndWhite,
}),
],
});
```
### `brandedLogo`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.brandedLogo,
}),
],
});
```
### `customProperty`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.customProperty,
}),
],
});
```
### `gradients`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.gradients,
}),
],
});
```
### `podcast`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.podcast,
}),
],
});
```
### `rauchg`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.rauchg,
}),
],
});
```
### `simpleBlog`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.simpleBlog,
}),
],
});
```
### `tailwind`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.tailwind,
}),
],
});
```
### `vercel`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.vercel,
}),
],
});
```
### `waveSvg`
```diff
import opengraphImages, { presets } from "astro-opengraph-images";
export default defineConfig({
integrations: [
opengraphImages({
+ render: presets.waveSvg,
}),
],
});
```
## Alternatives
Here are some similar libraries using Satori and Astro. I haven't done a feature comparison.
- https://github.com/florian-lefebvre/satori-astro (This library looks excellent)
- https://github.com/delucis/astro-og-canvas (Doesn't allow arbitrary layouts)
- https://github.com/thewebforge/astro-og-images (Only allows you to choose from a list of templates)
- https://github.com/tomaskebrle/astro-og-image (Seems limited)
- https://github.com/cijiugechu/astro-satori (Possibly dead, hasn't been updated in a year)
- https://github.com/kevinzunigacuellar/astro-satori (Possibly dead, hasn't been updated in a year)
- https://github.com/rumaan/astro-vercel-og (Possibly dead, hasn't been updated in a year)
## Maintainers
This README is hand-maintained; edit it directly.
- **Tests** — `bun run test` (runs `vitest src`).
- **Preset example images** — build the preset example site first, then render
the PNGs from the package root:
```bash
cd examples/preset && bun install && bun run build && cd ../..
bun run src/presets/render-examples.ts # writes assets/presets/.png
```
The separate `bun install` is deliberate. `examples/` is intentionally **not**
part of the root workspace: both examples declare the package name `example`,
so listing them would abort the root install with
`Workspace name "example" already exists`. Each example instead installs on
its own and pulls this package in through the `postinstall` hook
(`scripts/copy-example-deps.ts`), which copies the files named in our
`package.json` `files` field — mirroring what `npm pack` ships. That is the
point: the examples consume the package the way a published consumer does,
and it avoids the recursive symlink a `file:`/`link:` dependency would create
for a directory nested inside the package it depends on. Do not "fix" this by
adding `examples/*` to the root `workspaces`.
- **Publish** — `bun run publish:npm` (wraps `scripts/publish-npm.ts` at the
repo root).
