Skip to content

nuxt-modules/og-image

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 stable released!
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

Install nuxt-og-image dependency to your project:

npx nuxi@latest module add og-image

Documentation

📖 Read the full documentation for more information.

Sponsors

License

MIT License © 2023-PRESENT Harlan Wilton