Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: warn when using .svg in meta.image #377

Merged
merged 5 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,25 @@ type TemplateType = "html" | "node" | "angular-cli" | "create-react-app" | "java

```

### `meta`

**type**: `MetaTagsSchema`

Configures `<meta>` tags for Open Graph protocole and Twitter.
<PropertyTable inherited type="MetaTagsSchema" />

Example value:
```yaml
meta:
image: /cover.png
title: Title shown on social media and search engines
description: Description shown on social media and search engines
```

TutorialKit will use your logo as the default image.
If your logo uses the SVG format, it may not display on most social platforms.
Use a raster format instead, such as WEBP or PNG.

AriPerkkio marked this conversation as resolved.
Show resolved Hide resolved
AriPerkkio marked this conversation as resolved.
Show resolved Hide resolved
## Configure the Tutorialkit Astro integration

`@tutorialkit/astro` is an integration for Astro. You can configure the integration in your `astro.config.ts` file.
Expand Down
4 changes: 4 additions & 0 deletions packages/astro/src/default/components/MetaTags.astro
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ if (meta.image) {
}
}
imageUrl ??= readLogoFile('logo', true);
if (imageUrl?.endsWith('.svg')) {
console.warn(`Using a SVG open graph image "${imageUrl}". This is not supported by most social platforms.
You should rather set "meta.image" to a raster image (PNG, WEBP).`);
}
AriPerkkio marked this conversation as resolved.
Show resolved Hide resolved
---

<meta charset="UTF-8" />
Expand Down