Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Barbapapazes/og-image

Open more actions menu
 
 

Repository files navigation

nuxt-og-image

NPM version NPM Downloads GitHub stars

Generate OG Images with Vue templates in Nuxt.

Nuxt OG Image DevTools Preview


Status: v3 RC is available
Please report any issues 🐛
Made possible by my Sponsor Program 💖
Follow me @harlan_zw 🐦 • Join Discord for help

Features

  • ✨ Create an og:image using the built-in templates or make your own with Vue components
  • 🎨 Design and test your og:image in the Nuxt DevTools OG Image Playground with full HMR
  • ▲ Render using Satori: Tailwind / UnoCSS with your theme, Google fonts, 6 emoji families supported and more!
  • 🤖 Or prerender using the Browser: Supporting painless, complex templates
  • 📸 Feeling lazy? Just generate screenshots for every page: hide elements, wait for animations, and more
  • ⚙️ Works on the edge: Vercel Edge, Netlify Edge and Cloudflare Workers

Installation

  1. Install nuxt-og-image dependency to your project:
#
yarn add -D nuxt-og-image
#
npm install -D nuxt-og-image
#
pnpm i -D nuxt-og-image
  1. Add it to your modules section in your nuxt.config:
export default defineNuxtConfig({
  modules: ['nuxt-og-image']
})

Playgrounds

Documentation

📖 Read the full documentation for more information.

Sponsors

License

MIT License © 2023-PRESENT Harlan Wilton

About

Generate OG Images with Vue templates in Nuxt.

Resources

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages

  • TypeScript 63.1%
  • Vue 36.8%
  • JavaScript 0.1%
Morty Proxy This is a proxified and sanitized view of the page, visit original site.