Open
Conversation
c01fa20 to
89bbcea
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
5.1.13→6.0.1Release Notes
nuxt-modules/og-image (nuxt-og-image)
v6.0.1Compare Source
🐞 Bug Fixes
defineOgImage({ url })->useSeoMeta- by @harlan-zw in #496 (2e762)View changes on GitHub
v6.0.0Compare Source
Nuxt OG Image v6 brings a complete overhaul focused on performance, modern tooling, and developer experience.
📣 Highlights
📖 Migration Guide
Full migration guide: https://nuxtseo.com/og-image/migration-guide/v6
Quick Migration
Notable Changes
🚀 Takumi Renderer (Recommended)
Takumi is a Rust-based renderer that directly rasterizes to PNG/JPEG/WebP - no SVG intermediate step. It's 2-10x faster than Satori+Resvg.
See PR #414.
Takumi and Satori are feature-compatible within Nuxt OG Image - both support Tailwind CSS, custom fonts, emoji, edge runtimes, and all the same template features. The difference is speed: Takumi is always faster thanks to its Rust-based direct rasterization.
Use Takumi by creating components with the
.takumi.vuesuffix:See the Takumi docs for the full feature list.
🎨 First-Class CSS Support
Nuxt OG Image now has first-class support for multiple CSS approaches - not just Tailwind. All of these work out of the box with zero configuration:
See PR #430.
@themevalues just workprimary,secondary, etc.) are automatically resolvedNo configuration needed.
🖥️ Redesigned DevTools
The OG image DevTools have been completely overhauled:
⚡ Install Renderer Dependencies
Renderer dependencies are no longer bundled. Install what you need based on your renderer and runtime.
See PR #415.
Takumi (recommended):
Satori:
Browser:
Running
nuxi devwill prompt you to install missing dependencies automatically.🖼️ Multiple OG Images Per Page
Define multiple images with different dimensions for different platforms. Shared props are passed once and applied to all variants.
See PR #305.
Shared Props with Variants (Recommended)
Pass shared props as the second argument and size variants as the third — no prop duplication needed:
Per-variant props override shared props when needed:
Array Syntax
Alternatively, pass all options inline per variant:
🔤 @nuxt/fonts Integration
Custom fonts now use @nuxt/fonts instead of the legacy
ogImage.fontsconfig.See PR #432.
The
global: trueoption is required for fonts to be available in OG Image rendering.📦 Component Renderer Suffix
OG Image components now require a renderer suffix in their filename. This enables automatic renderer detection, multiple renderer variants, and tree-shaking.
See PR #433.
Run the migration CLI to rename automatically:
🏷️ Community Templates Must Be Ejected
Community templates (
NuxtSeo,SimpleBlog, etc.) are no longer bundled in production. Eject them to your project before building.See PR #426.
Templates continue to work in development without ejecting.
🔗 New URL Structure
OG Image URLs now use a Cloudinary-style format with options encoded in the path. This enables better CDN caching since identical options produce identical URLs.
See PR #305.
/__og-image__/image//_og/d//__og-image__/static//_og/s/🚨 Breaking Changes
🚀 Features
🐞 Bug Fixes
zeroRuntimemode - by @harlan-zw (7afb1)zeroRuntimemode - by @harlan-zw in #428 (97fb4)!important- by @harlan-zw (b5684)props={}in URLs - by @harlan-zw (7caa4)font-display-> font file - by @harlan-zw (3d4a5)defineOgImage()props - by @harlan-zw (4df12)<style>blocks - by @harlan-zw (64d59)getOgImagePathas deprecated - by @harlan-zw (00497)gap-*classes - by @harlan-zw in #465 (575c6)🏎 Performance
satori-htmlrequirement - by @harlan-zw (58738)View changes on GitHub
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.