search

stackblitz / tutorialkit

TutorialKit by StackBlitz - Create interactive tutorials powered by the WebContainer API
https://tutorialkit.dev
MIT License
503 stars 48 forks source link

docs: warning when using SVG open graph image #377

Open eric-burel opened 1 month ago

eric-burel commented 1 month ago

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.

stackblitz[bot] commented 1 month ago

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

AriPerkkio commented 6 days ago

Let's host a static png/jpg on tutorialkit.dev that used by default, instead of the default logo.svg. But let's also include this warning message from this PR.