File tree Expand file tree Collapse file tree 3 files changed +15
-4
lines changed
docs/tutorialkit.dev/src/content/docs/reference
astro/src/default/components Expand file tree Collapse file tree 3 files changed +15
-4
lines changed Original file line number Diff line number Diff line change @@ -430,6 +430,7 @@ type DownloadAsZip =
430430
431431Configures `<meta>` tags for Open Graph protocole and Twitter.
432432TutorialKit will use your logo as the default image.
433+ Relative paths are resolved to `public` directory.
433434<PropertyTable inherited type="MetaTagsSchema" />
434435
435436The `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
Original file line number Diff line number Diff line change @@ -7,13 +7,16 @@ interface Props {
77 meta? : MetaTagsConfig ;
88}
99const { 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+
1720imageUrl ?? = readLogoFile (' logo' , true );
1821---
1922
Original file line number Diff line number Diff 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} ) ;
You can’t perform that action at this time.
0 commit comments