In our visually-dominated digital landscape, Open Graph images are more than just aesthetic enhancements; they are crucial for making your web content stand out on social media platforms. Here is a preview of Open Graph image of a Quotion post:
However, implementing them in Vercel platforms starter kit (multi-tenancy platform), can be a bit tricky since it lacks out-of-the-box support for this feature. This post is your guide through this challenge, offering a practical solution to effectively integrate Open Graph images.
Understanding the Challenge with Multi-Tenancy Platforms
Before diving into the technicalities, let's clarify what we mean by a 'multi-tenancy platform.' In simple terms, it allows multiple users or 'tenants' to operate within the same application, each within their isolated segment of the platform. This architecture, while efficient, can complicate certain functionalities, such as the correct routing of Open Graph images.
The Core Issue
A multi-tenancy platform usually rewrites a request to a specific route, e.g. https://emma.quotion.co -> app/blog/[domain]/page.tsx, per Next.js doc, you should be able to build an open-graph image for it, for example you have this file :
Based on Next.js doc, this file should generate the open-graph image for your page automatically. However, this didn’t work, because the generated image points to the http://localhost:3000/blog/qing.quotion.co/opengraph-image due to URL rewrite, Next.js can’t find the correct route, which causes 404.
The root cause is Next.js doesn’t know the open-graph image should be rewritten to another route. Luckily, we can mitigate this issue with another open-graph approach:
A Viable Solution: Leveraging Metadata
Here's where metadata comes into play. By customizing your Open Graph image through metadata, you sidestep the URL misdirection issue. This function allows for more control and precision in how your Open Graph images are generated and displayed. Let's look at how this is achieved in the code:
Since /api/blog/og is a valid API path, this issue is resolved perfectly!
🙏 Thanks for reading, let me know if you have a better solution!
frontend
nextjs
Create your blogs directly from Apple Notes.
Say goodbye to complex CMS updates and management issues!
You focus on creating quality content while Quotion takes care of the rest.
Latest
More from the blog
Qing
Introducing Realtime Preview
Today, we're excited to announce, Quotion supports Realtime Preview now. You can preview your latest changes on your Quotion sites in realtime, no more refresh your page manually. Demo :::note Click any pen links will load your site in realtime preview mode. You don't need to click every post via the pen. ::: Checkout our
Read post
Qing
Introducing KaTeX
Many students are using Quotion. One of the most wanted features is KaTeX for math. Today, we're excited to share that Quotion now supports KaTeX out of the box. 🔥 Preview The note: The post: Tech details We need KaTeX css to render expressions correctly, but it is a pretty big chunk, to reduce the
Read post
Qing
Introducing comment widgets
Today, we are excited to announce a new feature on Quotion - comment widgets! This feature allows our valued customers to engage with their readers easily and create a sense of community around their content. The best part? You don't need to use any 3rd-party solutions to enable it! How to enable it Go to
Read post