66 lines
2.5 KiB
Markdown
66 lines
2.5 KiB
Markdown
---
|
|
name: Open Graph Image Generation
|
|
slug: og-image-generation
|
|
description: Compute and generate dynamic social card images with React components.
|
|
framework: Next.js
|
|
useCase: Edge Functions
|
|
css: Tailwind
|
|
deployUrl: https://vercel.com/new/clone?repository-url=https://github.com/vercel/examples/tree/main/edge-functions/vercel-og-nextjs&project-name=vercel-og-nextjs&repository-name=vercel-og-nextjs
|
|
demoUrl: https://og-examples.vercel.sh/api/static
|
|
relatedTemplates:
|
|
- nextjs-boilerplate
|
|
- aws-s3-image-upload-nextjs
|
|
- platforms-starter-kit
|
|
- blog-starter-kit
|
|
---
|
|
|
|
# Vercel OG + Next.js
|
|
|
|
This example shows how to use [Vercel OG](https://vercel.com/docs/concepts/functions/edge-functions/og-image-generation) with Next.js.
|
|
|
|
## Demo
|
|
|
|
- [Static Text](https://og-examples.vercel.sh/api/static)
|
|
- [Vercel Card](https://og-examples.vercel.sh/api/vercel)
|
|
- [Dynamic Text from URL Query](https://og-examples.vercel.sh/api/param)
|
|
- [Embed SVG Image](https://og-examples.vercel.sh/api/image-svg)
|
|
- [Dynamic PNG Image Based on URL Queries](https://og-examples.vercel.sh/api/dynamic-image?username=vercel)
|
|
- [Custom Font](https://og-examples.vercel.sh/api/custom-font)
|
|
- [Emoji](https://og-examples.vercel.sh/api/emoji)
|
|
- [Languages](https://og-examples.vercel.sh/api/language)
|
|
- [Encrypted Token](https://og-examples.vercel.sh/encrypted/a)
|
|
|
|
## How to Use
|
|
|
|
You can choose from one of the following two methods to use this repository:
|
|
|
|
### One-Click Deploy
|
|
|
|
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=vercel-examples):
|
|
|
|
[](https://vercel.com/new/clone?repository-url=https://github.com/vercel/examples/tree/main/edge-functions/vercel-og-nextjs&project-name=vercel-og-nextjs&repository-name=vercel-og-nextjs)
|
|
|
|
### Clone and Deploy
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example https://github.com/vercel/examples/tree/main/edge-functions/vercel-og-nextjs
|
|
# or
|
|
yarn create next-app --example https://github.com/vercel/examples/tree/main/edge-functions/vercel-og-nextjs
|
|
```
|
|
|
|
Next, run Next.js in development mode:
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
|
|
# or
|
|
|
|
yarn
|
|
yarn dev
|
|
```
|
|
|
|
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=edge-middleware-eap) ([Documentation](https://nextjs.org/docs/deployment)).
|