v3.0.0

✨ Nuxt OG Image v3 is here!

Check out the v3 release page for the full details.

For migrating from v2, please see the migration guide

   🚨 Breaking Changes

• Drop deprecated module config siteUrl, host  -  by @harlan-zw (0df3f)
• Remove hook og-image:prerenderScreenshots  -  by @harlan-zw (a7ee4)
• Rebuild core  -  by @harlan-zw (6f3b7)
• Remove deprecated defineOgImageDynamic, defineOgImageStatic  -  by @harlan-zw (6c1f3)
• Remove deprecated OgImageDynamic and OgImageStatic components  -  by @harlan-zw (850ca)
• Remove defineOgImageWithoutCache, defineOgImageCached  -  by @harlan-zw (7f22a)
• Rename runtimeBrowser -> runtimeChromium  -  by @harlan-zw (41a16)
• Rename default component NuxtSeo  -  by @harlan-zw (6052f)
• Require explicit opt-in for inlining css  -  by @harlan-zw (23404)
• Improved rendering of inline elements  -  by @harlan-zw (3f52c)
• Serve prerendered images at /__og-image__/static/*  -  by @harlan-zw (71b59)

   🚀 Features

• Improved Nuxt DevTools integration and layout  -  by @harlan-zw in #113 (477be)
• Modify resvg config with resvgOptions  -  by @harlan-zw (501ab)
• Integrate with @nuxt/content  -  by @harlan-zw (80205)
• Type safety with defineOgImageComponent  -  by @harlan-zw (9b3fe)
• New component templates  -  by @harlan-zw (5ed9a)
• Og images with only routeRules  -  by @harlan-zw (54ff5)
• Prerender all images through nitro  -  by @harlan-zw (f8c07)
• Experimental sharp support  -  by @harlan-zw (98cd0)
• Generate jpeg screenshots by default  -  by @harlan-zw (7cb72)
• Support any emoji set using iconify API  -  by @harlan-zw (0256d)
• Support any emoji set from Iconify  -  by @harlan-zw (a97d8)
• SWR caching with handled cache headers  -  by @harlan-zw (0b8aa)
• Implement default theme from @nuxtjs/color-mode  -  by @harlan-zw (89d31)
• UnJS template  -  by @harlan-zw (79d57)
• Use unocss for inlining tw classes with config extending  -  by @harlan-zw (6d90e)
• Support fonts option on defineOgImage  -  by @harlan-zw (0ae51)
• @css-inline wasm  -  by @harlan-zw (578e1)
• cloudflare_module support  -  by @bianpratama in #144 (aa026)
• Frame community template  -  by @arashsheyda in #181 (72e8e)
• Zero Runtime mode  -  by @harlan-zw (937e8)
• Zero Runtime mode  -  by @harlan-zw in #261 (14522)
• cloudflare: Optimize routes.json for prerendered og images  -  by @harlan-zw (a307a)
• devtools: New design  -  by @harlan-zw in #115 (a7ceb)

   🐞 Bug Fixes

• Rework server paths  -  by @harlan-zw in #114 (345f7)
• Disable module if in SPA mode  -  by @harlan-zw (059b7)
• Prerender fonts  -  by @harlan-zw (906ab)
• Broken screenshot import  -  by @harlan-zw (ff10a)
• Disable wasm handling while prerendering  -  by @harlan-zw (bbe8b)
• Auto set wasm targetEnv for netlify-edge  -  by @harlan-zw (e0145)
• Always mock prerenderer  -  by @harlan-zw (75b5f)
• Wasm loading util  -  by @harlan-zw (b96b6)
• Re-enable css-inline  -  by @harlan-zw (dda96)
• defineOgImage better route rule merging and false input  -  by @harlan-zw (a354d)
• Only inline css for satori SVG  -  by @harlan-zw (08e64)
• Screenshots jpg -> jpeg  -  by @harlan-zw (7c34d)
• Dedicated renderer debug function  -  by @harlan-zw (3d404)
• Avoid transforming absolute image URLs  -  by @harlan-zw (097a2)
• Allow imageSize to fail  -  by @harlan-zw (95cc0)
• Cache html payloads between requests  -  by @harlan-zw (3fc4d)
• Allow non-page apps to work  -  by @harlan-zw (7cc25)
• Refresh on template change  -  by @harlan-zw (d0b7f)
• Stackblitz demo  -  by @harlan-zw (56a16)
• Allow empty props  -  by @harlan-zw (a0e0e)
• Skip fonts in stackblitz  -  by @harlan-zw (91ae2)
• Skip remote fonts in stackblitz  -  by @harlan-zw (70b71)
• Skip remote fonts in stackblitz  -  by @harlan-zw (851b8)
• Use Nitro Server Assets for Inter font  -  by @harlan-zw (278ce)
• Prerender cache, screenshots and img resolving  -  by @harlan-zw (96dfb)
• Nicer NuxtSeo component  -  by @harlan-zw (30343)
• Make sure we get font asset as buffer  -  by @harlan-zw (8f382)
• Only use server assets for stackblitz development / prerendering  -  by @harlan-zw (b1bdc)
• Drop sharp wasm binary dependency  -  by @harlan-zw (2fb2a)
• Assert site.url is set when prerendering  -  by @harlan-zw (947e8)
• Clean up hooks  -  by @harlan-zw (51539)
• Default png, drop sharp  -  by @harlan-zw (bb5cb)
• Externalise sharp  -  by @harlan-zw (1eab2)
• Easy opt-ins for sharp, playwright deps  -  by @harlan-zw (b0b3f)
• Add Pergel template  -  by @harlan-zw (3ae06)
• Disable sharp if missing dependency  -  by @harlan-zw (3733b)
• Compatibility api  -  by @harlan-zw (2730b)
• Compatibility api  -  by @harlan-zw (2fe70)
• Compatibility api  -  by @harlan-zw (bd858)
• Screenshoting  -  by @harlan-zw (97f6b)
• Allow chrome launcher to fail  -  by @harlan-zw (74d5e)
• Always ensure chromium in a CI  -  by @harlan-zw (1c727)
• Keep browser open while prerendering and support recovery  -  by @harlan-zw (9e1ee)
• Avoid chrome process hanging while prerendering  -  by @harlan-zw (2e8e2)
• Maybe avoid chrome process hanging while prerendering  -  by @harlan-zw (7ac55)
• Revert changes  -  by @harlan-zw (2c579)
• Close browser when prerendering  -  by @harlan-zw (e34f2)
• Close browser when prerendering  -  by @harlan-zw (21618)
• Close browser when prerendering  -  by @harlan-zw (a2a3a)
• Don't make components global by default  -  by @harlan-zw (1685b)
• Ensure dev chromium if it's been explicitly enabled  -  by @harlan-zw (22611)
• Use fallback colour mode if preference is system  -  by @harlan-zw (ba0c7)
• Merge tailwind theme into satori  -  by @harlan-zw (50b8d)
• Transform background image url  -  by @harlan-zw (b552c)
• Nitro imports  -  by @harlan-zw (e5181)
• Nuxt content merging  -  by @harlan-zw (acb98)
• Satori parser regression  -  by @harlan-zw (87066)
• Fallback to resvg wasm if the dependency fails to import  -  by @harlan-zw (d3d3e)
• Insert twitter:image to resolve useSeoMeta conflict  -  by @harlan-zw (e6e1d)
• runtimeCacheStorage regression, propagate cache error  -  by @harlan-zw (d8a92)
• Respect query params  -  by @harlan-zw (7c13f)
• Broken dynamic types output  -  by @dargmuesli in #120 (7d7e6)
• Empty query in meta  -  by @harlan-zw (685f4)
• Ensure nitro options are initialized  -  by @harlan-zw (58846)
• nitro.compressPublicAssets breaking images #123  -  by @harlan-zw in #123 (53420)
• Nitro re-export warnings  -  by @harlan-zw (c7eee)
• Font resolution regression  -  by @harlan-zw (ef537)
• Font resolution regression #2  -  by @harlan-zw in #2 (384fc)
• Maybe fix font regression #3  -  by @harlan-zw in #3 (8ad80)
• Accessing prerender on null  -  by @harlan-zw (34022)
• Require explicit opt-in to jpeg image rendering  -  by @harlan-zw (3aaa4)
• Avoid trailingSlash breaking route rule config  -  by @harlan-zw (dd42f)
• Custom fonts, + name and style="font-family: <font>"  -  by @harlan-zw (2da22)
• Remove data-v-inspector artifacts from template  -  by @harlan-zw (cd7ab)
• Require nuxt 3.9  -  by @harlan-zw (12d7b)
• Wrong css-inline wasm path  -  by @harlan-zw (92abe)
• Await css-inline wasm promise  -  by @harlan-zw (acfc3)
• Extract meta description as default prop  -  by @harlan-zw (ed747)
• Css-inlining logic for new island css processing  -  by @harlan-zw (8d132)
• Maybe fix cloudflare pages wasm resolving for css-inline  -  by @harlan-zw (e8d3f)
• Disable css-inline on cloudflare  -  by @harlan-zw (f867b)
• Maybe fix cloudflare fonts  -  by @harlan-zw (a33bc)
• Only warn about inlining css for cloudflare  -  by @harlan-zw (7f177)
• Nuxt/content documentDriven allow missing path  -  by @harlan-zw (9183b)
• Safer version resolution  -  by @harlan-zw (5c790)
• defineOgImageComponent type shouldn't use dir prefix  -  by @harlan-zw (f41ad)
• Replace dir names from types sorted by length  -  by @harlan-zw (9a162)
• Broken prerendered absolute image urls  -  by @harlan-zw (33c3b)
• Broken prerendered background images  -  by @harlan-zw (fb743)
• Sass breaking vite css-loader  -  by @harlan-zw (a4188)
• Support codesandbox  -  by @harlan-zw (d0e64)
• On-demand chromium for dev / prerender  -  by @harlan-zw in #150 (b57ee)
• Use server storage for fonts  -  by @harlan-zw in #151 (123ab)
• Add types for nitro build  -  by @harlan-zw (dab7c)
• Use updated twitter card renderer  -  by @harlan-zw (cb834)
• Mock composables when enabled: false  -  by @harlan-zw (29a9e)
• Disable css-inline wasm in vercel-edge  -  by @harlan-zw (7c729)
• Allow routes with . in them  -  by @harlan-zw (93a5a)
• Don't skip normalising routes with . in final segment  -  by @danielroe and @harlan-zw in #161 (84409)
• Allow css inlining to fail  -  by @harlan-zw (d258a)
• Update type source of wasm option  -  by @danielroe in #173 (be96e)
• Workaround for nitro json regression  -  by @harlan-zw (8196a)
• Require Nuxt 3.10.3  -  by @harlan-zw (e84ce)
• Unwasm module loading strategy  -  by @harlan-zw (43694)
• Interop default wasm exports  -  by @harlan-zw (7a99f)
• Nitro export warning  -  by @harlan-zw (862ff)
• Working css-inline version  -  by @harlan-zw (73a21)
• Adopt forward-compatible approach to builder:watch  -  by @danielroe in #183 (de8d5)
• app.baseURL not being appended  -  by @harlan-zw (e2d93)
• Default baseURL being applied twice  -  by @harlan-zw (5c08c)
• Options cache integrity when prerendering  -  by @harlan-zw (32960)
• Avoid nitro preset overriding development preset  -  by @harlan-zw (41d61)
• Avoid nitro preset overriding development preset  -  by @harlan-zw (e05c6)
• Images broken for non-jpeg, extension-less paths  -  by @harlan-zw and @maximepvrt in #202 (54b5b)
• Dynamic font src not resolving when prerendering  -  by @harlan-zw (88be3)
• Avoid fetch attempt of data uri images  -  by @harlan-zw (2062f)
• Avoid dimension resizing of data uri images  -  by @harlan-zw (a7a3f)
• Stop using 'terminate' package to avoid GPL  -  by @sethidden in #217 (ffbff)
• Stop using 'terminate' package to avoid GPL  -  by @sethidden (516de)
• sharp opt-out with sharpOptions.disabled  -  by @harlan-zw (b0e92)
• Require explicit opt-in to sharp logic  -  by @harlan-zw (50777)
• Support custom src folders  -  by @harlan-zw (2b987)
• Nuxt and pergel community template issues  -  by @jsayer101 in #227 (6f098)
• Resolve publicDirAbs correctly  -  by @KazariEX in #231 (7e956)
• Support @nuxt/icon  -  by @harlan-zw (061d3)
• Resolve public dir backwards compat  -  by @harlan-zw (58151)
• Remove nuxt-icon as dependency  -  by @harlan-zw (f0e3c)
• Prefer wasm @css-inline/css-inline dep  -  by @harlan-zw in #237 (f4202)
• Stricter opt-in for inline styling  -  by @harlan-zw in #240 (adaa2)
• Support defaults.url  -  by @harlan-zw (bbfe7)
• Saner default cache base path  -  by @harlan-zw (0bfc8)
• false opt-out of title and description  -  by @harlan-zw (1ea8a)
• Normalize component with route rules  -  by @harlan-zw (39270)
• Support SERVER_PRESET to detect env  -  by @harlan-zw (00d09)
• Support computed getters and ref props  -  by @harlan-zw (675c0)
• Broken route rule extending  -  by @harlan-zw (f4e02)
• Warn on satori .webp usage  -  by @harlan-zw (0b66a)
• useNitroApp build warnings  -  by @harlan-zw (551b8)
• Check wasm file exists for checksum  -  by @harlan-zw (ca71c)
• Serve cached fonts when rendering html previews  -  by @harlan-zw (f77e0)
• Clear unused font caches on start  -  by @harlan-zw (bb918)
• Fallback to first og image component on failure  -  by @harlan-zw (3d70c)
• Import shared utils from alias paths  -  by @harlan-zw (887ee)
• unstorage backwards compatible  -  by @harlan-zw (dcca9)
• NuxtSeo:
  • Ensure icon is booleanable  -  by @harlan-zw (f729b)
• client:
  • Show actual module version  -  by @harlan-zw (35451)
  • Fixed link to tutorial  -  by @shinGangan in #233 (75676)
• content:
  • Upgrade content payload to primary when not merging  -  by @harlan-zw (b82d8)
  • Exception when configuring ogImage from markdown files  -  by @harlan-zw (18bb3)
  • Normalise frontmatter component name  -  by @harlan-zw (f2184)
  • strictNuxtContentPaths config  -  by @harlan-zw (2b7c6)
• devtools:
  • Qol improvements  -  by @harlan-zw (833a0)
  • Site url in twitter embed  -  by @harlan-zw (4dda3)
  • Update Nuxt SEO logo  -  by @harlan-zw (b144d)
  • Social preview not updating  -  by @harlan-zw (aa677)
  • Better UI for twitter title  -  by @harlan-zw in #239 (73291)
  • index.html not being generated  -  by @harlan-zw (f92e7)
  • Avoid recursion bug on debug tab  -  by @harlan-zw (409a5)
• playwright:
  • Disable animations by default  -  by @harlan-zw (10128)
• satori:
  • Always strip inline and inline-block styles  -  by @harlan-zw (06487)
• stackblitz:
  • Disable css-inline by default  -  by @harlan-zw (92187)
• templates:
  • Text invisible on Nuxt SEO template with dark mode  -  by @harlan-zw (ec5d9)
• types:
  • Ensure number  -  by @harlan-zw (d0ef6)
• unocss:
  • Convert rgb(r b g / opacity) to rgba  -  by @harlan-zw (aff6e)

   🏎 Performance

• Improved image buffer resolving  -  by @harlan-zw (480c5)
• Process all transforms in parallel  -  by @harlan-zw (28c52)
• Use devalue over JSON.stringify, JSON.parse  -  by @harlan-zw (09a1d)

    View changes on GitHub