Skip to content

Commit b019815

Browse files
committed
fix(astro): URLs in meta.image
1 parent 71d4c6a commit b019815

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

docs/tutorialkit.dev/src/content/docs/reference/configuration.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,7 @@ type DownloadAsZip =
430430

431431
Configures `<meta>` tags for Open Graph protocole and Twitter.
432432
TutorialKit will use your logo as the default image.
433+
Relative paths are resolved to `public` directory.
433434
<PropertyTable inherited type="MetaTagsSchema" />
434435

435436
The `MetaTagsSchema` type has the following shape:
@@ -449,6 +450,13 @@ meta:
449450
image: /cover.png
450451
title: Title shown on social media and search engines
451452
description: Description shown on social media and search engines
453+
454+
meta:
455+
image: /cover.png # Resolves to public/cover.png
456+
457+
meta:
458+
image: 'https://tutorialkit.dev/tutorialkit-opengraph.png' # URL is used as is
459+
452460
```
453461

454462
:::tip

packages/astro/src/default/components/MetaTags.astro

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,16 @@ interface Props {
77
meta?: MetaTagsConfig;
88
}
99
const { meta = {} } = Astro.props;
10-
let imageUrl;
11-
if (meta.image) {
12-
imageUrl = readPublicAsset(meta.image, true);
10+
let imageUrl = meta.image;
11+
12+
if (imageUrl?.startsWith('/') || imageUrl?.startsWith('.')) {
13+
imageUrl = readPublicAsset(imageUrl, true);
14+
1315
if (!imageUrl) {
1416
console.warn(`Image ${meta.image} not found in "/public" folder`);
1517
}
1618
}
19+
1720
imageUrl ??= readLogoFile('logo', true);
1821
---
1922

packages/types/src/schemas/metatags.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export const metaTagsSchema = z.object({
88
* Ideally we would want to use `image` from:
99
* https://docs.astro.build/en/guides/images/#images-in-content-collections .
1010
*/
11-
.describe('A relative path to an image that lives in the public folder to show on social previews.'),
11+
.describe('Image to show on social previews. A relative path is resolved to the public folder.'),
1212
description: z.string().optional().describe('A description for metadata'),
1313
title: z.string().optional().describe('A title to use specifically for metadata'),
1414
});

0 commit comments

Comments
 (0)