fix: warn when using .svg in meta.image
#377
Merged
Conversation
This file contains 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
|
|
eric-burel
changed the title
eric-burel
changed the title
AriPerkkio
reviewed
Oct 18, 2024
AriPerkkio
reviewed
Oct 18, 2024
docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx
Outdated
Show resolved
Hide resolved
AriPerkkio
reviewed
Oct 18, 2024
docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx
Outdated
Show resolved
Hide resolved
|
Let's host a static png/jpg on |
AriPerkkio
changed the title
.svg in meta.image
AriPerkkio
approved these changes
Nov 25, 2024
There was a problem hiding this comment.
Looks good, thanks @eric-burel!
I'll do a follow-up PR that changes the default og-image to 'https://tutorialkit.dev/tutorialkit-opengraph.png' instead of logo.svg.
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.
I figured the hard way that most social platforms won't actually support SVG open graph cover images, which might be confusing since we use the logo as the default cover image, and the default logo is SVG.
I've added a warning to detect this scenario, and added some documentation.
Maybe we could later improve the default setup to provide a default .png cover image directly? I've tested setting "meta.image" at tutorial level for all lessons and it works perfect, so maybe we could include a TutorialKit cover as "cover.png" and configure it directly there, rather than falling back on the logo.